Extended Robot Framework Template

Describe your robot here. E.g. what it does, what are the requirements, how to run it.

Development guide

Run the robot locally:

rcc run

Provide access credentials for Robocorp Cloud connectivity:

rcc configure credentials <your_credentials>

Upload to Robocorp Cloud:

rcc cloud push --workspace <workspace_id> --robot <robot_id>

Suggested directory structure

The directory structure given by the template:

├── devdata
├── keywords
│   └── keywords.robot
├── libraries
│   └── Library.py
├── variables
│   └── variables.py
├── conda.yaml
├── robot.yaml
└── tasks.robot

where

  • devdata: place for all data/material related to development, e.g. test data. Do not put any sensitive data here!
  • keywords: Robot Framework keyword files.
  • libraries: Python library code.
  • variables: Define your robot variables in a centralized place. Do not put any sensitive data here!
  • conda.yaml: Environment configuration file.
  • robot.yaml: Robot configuration file.
  • tasks.robot: Robot Framework task suite - high level process definition.

In addition to these you can create your own directories (e.g. bin, tmp). Add these directories to the PATH or PYTHONPATH section of robot.yaml if necessary.

Logs and artifacts are stored in output by default - see robot.yaml for configuring this.

See Docs for handling variables and secrets.

Configuration

Give the task name and startup commands in robot.yaml with some additional configuration. See Docs for more.

Put all the robot dependencies in conda.yaml. Robocorp App (and rcc) uses Conda for managing the execution environment. For development you can also install packages manually with pip.

Additional documentation

See Robocorp Docs for more documentation.

Discover more robots