Developer Documentation

Platform Overview

CyberOak is a cloud-native RPA platform that runs standard Python scripts. Unlike traditional RPA that relies on visual recorders, CyberOak gives you full code-level control.

The Automation Workflow

Python Runtime Environment

Your robots execute in an isolated sandbox environment.

• Python Version 3.11.7
• Operating System Linux (Debian/Ubuntu based)

Handling Inputs & Secrets

Avoid hardcoding sensitive data. CyberOak provides two ways to inject data into your script at runtime.

1. Environment Variables (Secrets)

Defined in the "secrets" tab of your robot. Securely encrypted.

# Access a secret defined in the UI
db_password = parameters.get('ORACLE_DB_PASS')

2. Runtime Variables

Defined in "Parameters" section. Useful for dynamic parameters.

# 'inputs' is a global dictionary available in the runtime
target_email = inputs.get('notification_email')

Built-in Helper Functions

The platform exposes specific utility functions globally to simplify common tasks like saving reports or generating PDFs.

# 1. Saving simple text/JSON
import json
data = {"status": "success", "processed": 50}
save_file("log.json", json.dumps(data))

# 2. Saving an in-memory Excel file (using BytesIO)
from io import BytesIO
from openpyxl import Workbook

wb = Workbook()
ws = wb.active
ws['A1'] = "Report Data"
buffer = BytesIO()
wb.save(buffer)
save_file("Weekly_Report.xlsx", buffer)

# template_file: Name of the HTML file uploaded in 'File Inputs'
# context_dict: Data to inject into the template

context = {"user_name": "Alice", "date": "2025-01-01"}
pdf_bytes = generate_pdf("invoice_template.html", context)
save_file("Invoice_Alice.pdf", pdf_bytes)

def heavy_calc(x):
    return x * x

# Automatically distributes work
results = list(executor.map(heavy_calc, range(1000)))

Database Connectivity

We support the following adapters out of the box:

• PostgreSQL: psycopg2 (v2.9.11)
• Oracle: oracledb (v3.4.1)
• MySQL: mysqlclient (v2.2.7)

Pre-installed Libraries

No pip install required. The following libraries are available in the environment:

Web & Scraping

Data Processing & Office

Utilities & Cloud

Coding Guidelines

• Validation: Raise ValidationError for recoverable issues rather than crashing with exit(1).
• Logging: Use the standard logging module. All stdout/stderr is captured in the Orchestrator logs.
• Paths: Do not rely on absolute paths like C:/Users/.... Use relative paths or the temporary directory.