<!-- pyOpenRPA documentation master file, created by
sphinx-quickstart on Sat Dec 19 23:59:00 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. -->
# Портал документации pyOpenRPA


![image](img/ModalGuide.png)

## Дорогие коллеги!

Добро пожаловать на портал документации pyOpenRPA.

pyOpenRPA – это прогрессивная RPA платформа, которая позволяет сочетать в рамках одного проекта все перспективные технологии, такие как:

!ВНИМАНИЕ! Платформа pyOpenRPA включена в единый реестр российских программ для ЭВМ и БД


* OCR / NLP / NER: Распознавание изображений и текста


* CV: Компьютерное зрение


* AI: Искусственный интеллект


* ML: Машинное обучение


* BIGDATA: Большие данные


* VOICE & CHAT: Голосовые и чат-боты

Роботов pyOpenRPA невозможно отключить принудительно - управлять ими будете только вы!

**Сегодня на рынке RPA явно выражены 4 проблемы:**


* Программные роботы RPA являются настолько дорогими, что точно окупаются только в крупном бизнесе.


* Архитектура закрытых платформ RPA содержит очень ограниченный набор передовых технологий. А подключение таковых в платформу приходится выполнять только через выпуск новых версий.


* Возникающие дефекты закрытых платформ RPA блокируют выполнение всего робота.


* Зависимость RPA платформы от ключа активации вендора может заблокировать работу всех ранее разработанных роботов (пример с санкциями от западных компаний, а помимо санкций возникают и другие причины).

Платформа pyOpenRPA глобально меняет рынок RPA и решает все вышеперечисленные проблемы. Более того, наше решение делает программную роботизацию RPA выгодной и эффективной с бизнес-эффекта всего от 10 тыс. рублей! Тем самым мы даём возможность технологического развития даже для микропредприятий! В компании ООО «ОПЕН РПА» мы создаем стандарты вендора / поставщика софта нового поколения. Предлагаем уникальный набор услуг для каждого клиента вплоть до реализации проекта под ключ с учетом максимальной экономической эффективности.

Наша открытость и ряд стратегических инициатив позволяют нам быть предельно прозрачными перед всеми участниками рынка. Предлагать индивидуальный набор услуг, нацеленный на решение проблем клиента.

С презентацией pyOpenRPA вы можете ознакомиться по ссылке: [[СМОТРЕТЬ PDF]](https://pyopenrpa.ru/Index/pyOpenRPA_product_service.pdf) . Если возникнут вопросы, то вы всегда можете обратиться к нам (контакты см. в презентации).

pyOpenRPA - роботы помогут!

**Иван Маслов, основатель и генеральный директор ООО «ОПЕН РПА» (pyOpenRPA LLC)**

## Лицензия pyOpenRPA

Лицензия pyOpenRPA разрешает бесплатное использование только для некоммерческих организаций и физических лиц (не ИП и не самозанятый). В остальных случаях требуется получение цифрового сертификата от правообладателя (ООО «ОПЕН РПА»).

**Для коммерческого использования:**


* **Вариант 1:** Подписка на премиальную техническую поддержку от вендора (ежемесячно от 66 900 руб. без НДС)


* **Вариант 2:** Покупка бессрочной лицензии на текущую версию pyOpenRPA и ниже (разовый платеж 299 000 руб. без НДС)


* **Вариант 3:** Покупка бессрочной лицензии на 1-го робота, который будет использовать текущую версию pyOpenPRA и ниже (разовый платеж 99 000 руб. без НДС)

Используя ПО pyOpenRPA Вы осознаете свою ответственность в случаях нарушения лицензионного законодательства и совершения неправомерных действий.

Подробнее про лицензирование: 2. Лицензия & Контакты

## О портале и программе

Дорогие коллеги!

На портале вы найдете все необходимое описание для решения любой задачи программной роботизации RPA.

Платформа pyOpenRPA является одной из самых производительных: скорость выполнения операций не уступает другим западным и Российским RPA аналогам. А в ряде случаев pyOpenRPA отрабатывает в 2 - 4 раза быстрее.

С 2019 года pyOpenRPA применяется в малом / среднем / крупном сегментах бизнеса для:


* отказа от западных RPA платформ;


* аудита финансовой и ИТ функций;


* прототипирования бизнес-процессов без изменения ИТ ландшафта;


* оптимизации нагрузки на коллег из классической автоматизации (legacy / back / front);


* реализации автотестов выпускаемых программ.

pyOpenRPA является программой с открытым исходным кодом. С исходными кодами можно ознакомиться по адресу: [https://gitlab.com/UnicodeLabs/OpenRPA](https://gitlab.com/UnicodeLabs/OpenRPA)

Если у вас останутся вопросы, то вы всегда можете обратиться в центр поддержки клиентов pyOpenRPA. Контакты: 2. Лицензия & Контакты

pyOpenRPA - роботы помогут!

### Портал состоит из следующих разделов:


* ОБЩЕЕ


* МОДУЛЬ РОБОТ


* МОДУЛЬ СТУДИЯ


* МОДУЛЬ ОРКЕСТРАТОР


* МОДУЛЬ АГЕНТ


* ИНСТРУМЕНТЫ

### ОБЩЕЕ

В разделе описание общие положения, такие как: Описание структуры портала, инструкция по развертыванию и запуску pyOpenRPA, информация о правообладателе, контакты.

### МОДУЛЬ РОБОТ

Модуль обеспечивает всю необходимую функциональность для создания любого программного робота RPA. Модуль робота поставляется в качестве библиотеки Python, что позволяет с легкостью интегрировать его в другие проекты перспективных технологий.

**Содержит**


* Уровень доступа к элементам локального приложения (win32, UI automation), и веб приложения


* Уровень доступа к текстовым каналам передачи данных (клавиатура, буфер обмена)


* Уровень доступа к графическим каналам передачи данных (мышь, экран)

Подробное описание модуля: 1. Описание.

### МОДУЛЬ СТУДИИ

Модуль является инструментом для отладки проектируемых узлов программного робота RPA. Запускается в качестве обособленного приложения в веб-браузере.

**Основные возможности**


* Поиск и запуск доступных действий над UI элементом


* Чтение и запись атрибутов UI элемента


* Визуальное прототипирование алгоритма


* Редактирование UI селекторов


* Поиск UI элементов по наведению мыши


* Поиск UI элементов в дереве UI объектов


* Автоматизированная генерация UI селекторов

Подробное описание модуля: 1. Описание.

### МОДУЛЬ ОРКЕСТРАТОР

Модуль, который становится необходим, когда речь идет от нескольких работающих роботах. Запуск, остановка, контроль активности, проверка удаленных сессий, панель управления для бизнес-сотрудников - всё это можно реализовать в оркестраторе.

**Основные возможности**


* Запуск / пауза / безопасная остановка / принудительная остановка робота


* Интеллектуальное расписание


* Просмотр состояния графических сессий роботов через панель управления


* Удаленное администрирование сессий оркестратора и робота


* Среда отладки функциональности через панель управления оркестратора


* Консолидированное хранилище логов, доступное для просмотра через панель управления


* Ролевая модель разграничения доступа


* Функциональность очередей для координации роботов

### МОДУЛЬ АГЕНТ

Модуль, который обеспечивает необходимую связь графической сессии робота с сессией оркестратора.

**Основные возможности**


* Выполнение команд на сессии робота и возвращение результата на источник запроса


* Получение скриншотов работы графической сессии


* Отправка / получение больших файлов (более 2 гб.)

## Технические требования

ВЕРСИЯ v1.3.0

! ВНИМАНИЕ ! Требуется пакет KB2999226 если используется windows Vista/7/8/8.1/Server 2008/Server 2012 [https://support.microsoft.com/ru-ru/help/2999226](https://support.microsoft.com/ru-ru/help/2999226)
Использование компонента OpenCV: ОС Windows 7/8/8/10 (Windows Server только с 2016)
В июле 2022 будет выпущен релиз pyOpenRPA, который будет работать на ОС семейства Linux (Ubuntu / Astra)


* ОС Windows 7+ / Server 2008+.


* RAM 512+ Гб


* HDD 2+ Гб


* CPU 1+ ГГц

## Структура репозитория

Описание каждой папки репозитория pyOpenRPA:


* **Agent**: Преднастроенный компонент pyOpenRPA Agent (Агент)


* **Orchestrator**: Преднастроенный компонент pyOpenRPA Orchestrator (Оркестратор)


* **Resources**: Сторонние ресурсы, используемые в pyOpenRPA.


* **Robot**: Преднастроенный компонент pyOpenRPA Robot (Робот)


* **Sources**: Исходные коды pyOpenRPA + исходные коды документации pyOpenRPA


* **Studio**: Преднастроенный компонент pyOpenRPA Studio (Студия)


* **Utils**: Вспомогательные инструменты для разработчика робота на pyOpenRPA


* **Wiki**: Документация, дополнительные материалы

## Wiki структура

В папке Wiki представлены следующие материалы:


* RUS Портал документации в формате HTML [[|ОТКРЫТЬ GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Guide/html/index.html)


* RUS Портал документации в формате MarkDown [[|ОТКРЫТЬ GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Guide/markdown/index.md)


* RUS Портал документации в формате PDF [[|ОТКРЫТЬ GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Guide/pdf/pyOpenRPA_Guide_RUS.pdf)


* RUS Практическое руководство по работе с Desktop UI [[|ОТКРЫТЬ HABR|]](https://habr.com/ru/post/509644/); [[|ОТКРЫТЬ GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Tutorial/DesktopGUI_Habr/index.md)


* RUS Практическое руководство по работе с Web UI [[|ОТКРЫТЬ HABR|]](https://habr.com/ru/post/515310/); [[|ОТКРЫТЬ GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Tutorial/WebGUI_Habr/readme.md)


* ENG портал документации в формате HTML [[|OPEN GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/html/index.html)


* ENG портал документации в формате MarkDown [[|OPEN GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/markdown/index.md)


* ENG портал документации в формате PDF [[|OPEN GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/pdf/pyOpenRPA_Guide_ENG.pdf)

2. Лицензия & Контакты

## ОГЛАВЛЕНИЕ


* [Выбрать версию](https://pyopenrpa.ru/wiki/guide/index)


* 1. Первый запуск (Windows & Linux)


    * Первый запуск (Windows)


    * Первый запуск (Linux)


    * Проверить, что pyOpenRPA развернута корректно? (Windows)


    * Проверить, что pyOpenRPA развернута корректно? (Linux)


    * Быстрая навигация


* 2. Лицензия & Контакты


    * Лицензия


    * Автор


    * Правообладатель


    * Центр поддержки клиентов


    * Иван Маслов (генеральный директор ООО «ОПЕН РПА»)


    * Используемые сторонние компоненты (лицензионная чистота)


    * Быстрая навигация


* 1. Описание


    * Общее


    * Примеры


    * Быстрая навигация


* 2. Функции UIDesktop


    * Общее


    * Описание функций


    * Селектор UIO


    * Быстрая навигация


* 3. Функции UIWeb


    * Общее


    * Описание функций


    * Быстрая навигация


* 4. Функции Keyboard


    * Общее


    * Доп. настройки в LINUX


    * Примеры использования


    * Описание функций


    * Коды клавиш


    * Дополнительная функциональность


    * Быстрая навигация


* 5. Функции Clipboard


    * Описание функций


    * Быстрая навигация


* 6. Функции Mouse


    * Общее


    * Описание функций


    * Быстрая навигация


* 7. Функции Screen


    * Общее


    * Класс Box


    * Класс Point


    * Символьное указание точки (inPointRuleStr)


    * Символьное указание области (inAnchorRuleStr)


    * Описание функций


    * Быстрая навигация


* 8. Как использовать?


    * Как запустить скрипт робота?


    * Быстрая навигация


* 1. Описание


    * Общее


    * Быстрая навигация


* 2. Как использовать?


    * Общее


    * Как запустить?


    * Описание UI студии


    * Извлечь UI дерево


    * Поиск UI объекта по наведению мыши


    * Извлечь свойства UI объекта


    * Быстрая навигация


* 1. Описание


    * Общее


    * Концепция единого глобального словаря настроек (GSettings)


    * Архитектура


    * Быстрая навигация


* 2. Функции


    * Общее


    * Что такое активность (ActivityItem)?


    * Функции


    * Быстрая навигация


* 3. Настройки GSettings (шаблон)


    * Общее


    * Структура


    * Быстрая навигация


* 4. Как использовать?


    * Как запустить?


    * Параметры настройки


    * Быстрая навигация


* 5. Права доступа пользователей UAC


    * Описание


    * UAC Dict for Orchestrator WEB UI rights


    * Быстрая навигация


* 2. Функции Agent


    * Общее


    * Описание функций


    * Быстрая навигация


* 2. Функции StopSafe


## Быстрая навигация


* [Сообщество pyOpenRPA (telegram)](https://t.me/pyOpenRPA)


* [Сообщество pyOpenRPA (tenchat)](https://tenchat.ru/iMaslov?utm_source=19f2a84f-3268-437f-950c-d987ae42af24)


* [Сообщество pyOpenRPA (вконтакте)](https://vk.com/pyopenrpa)


* [Презентация pyOpenRPA](https://pyopenrpa.ru/Index/pyOpenRPA_product_service.pdf)


* [Портал pyOpenRPA](https://pyopenrpa.ru)


* [Репозиторий pyOpenRPA](https://gitlab.com/UnicodeLabs/OpenRPA)

		.. v1.3.0 replace:: v1.3.0