Robotic Enterprise Framework — это шаблон проекта, основанный на State Machines, создан с учетом всех передовых методов ведения журналов, обработки исключений, инициализации приложений и т. д. и готов к решению сложных бизнес-сценариев.

Логика шаблона основана на REFramework UiPath и имеет схожую архитектуру.

Версия "_NoQueue" предназначена для проектов, архитектура которых не предполагает взаимодействие с очередями PIX Master и не разбивается на Dispatcher\Performer, транзакции создаются и обрабатываются за один запуск.

Шаблон разработан совместными усилиями команд ООО "Первый бит" и ПАО «ГМК "Норильский Никель"»

1. Функциональные преимущества
2. Файловая структура проекта
3. Параметры
4. Main.pix
5. STATE 1: Инициализация
6. STATE 2: Общие действия для всех транзакций
7. STATE 3: Получение данных транзакции
8. STATE 4: Обработка/создание транзакции
9. STATE 5: Завершение
10. InitAllSettings.pix
11. Чтение конфигурационного файла
12. KillProcesses.pix
13. Notification.pix
14. TakeScreenshot.pix
15. CreateTransactions.pix
16. GetTransaction.pix
17. PreProcess.pix
18. Process.pix
19. Finalize.pix
20. Памятка по эксплуатации

• Реализовано без использования "GoTo".
• Возможность переключения среды (тестирование, продуктив) для запуска робота без изменений в проекте.
• Использование специализированных словарей для хранения данных.
• Возможность указания данных PIX Master (Text, Secure Data, Authorization), Windows Credentials и String значений в конфигурационном файле с дальнейшим распределением внутри проекта в соответствующие словари.
• Реализованы дополнительные функциональные скрипты (Отправка сообщений, Скриншот и т.п.).
• Возможность ограничения количества транзакций для обработки за один запуск.
• Реализованы попытки выполнения транзакций.
• Автоматическое формирование таблицы со статусами обработки транзакций.

REFramework_Queue

• Data
  • Config.xlsx
• FrameworkScripts
  • InitAllSettings.pix
  • KillProcesses.pix
  • Notification.pix
  • TakeScreenshot.pix
• TransactionScripts
  • CreateTransactions.pix
  • Finalize.pix
  • GetTransaction.pix
  • PreProcess.pix
  • Process.pix
• Main.pix

Схема работы State Machine

Блок предназначен для первичной настройки окружения и считывания конфигурационных данных. В процессе подготовки робот:

1. Записывает лог о начале работы.
2. Закрывает приложения, которые могут помешать работе текущего процесса.
3. Считывает конфигурационный файл.
4. Инициализирует проектные папки.

Ошибка записывается out параметром блока Catch в переменную exc_main для последующей обработки. Источник ошибки перезаписывается отдельным шагом блока Catch для корректного вывода скрипта\шага ошибки.

• Есть ошибки - переход в STATE 5: Завершение
• Нет ошибок - переход в STATE 2: Общие действия для всех транзакций

Блок предназначен для наполнение пула транзакций для дальнейшей обработки и выполнения общих действий. К общим действиям относятся - запуск приложений, авторизация на сайте и т.п.

При отсутствии данных для обработки - вызывается бизнес исключение "Отсутствуют новые транзакции для обработки"

Количество запусков:

При отсутствии ошибок во время работы робота, STATE 2 вызывается один раз после инициализации первичных настроек.

При возникновении ошибок, в зависимости от настроек проекта, STATE 2 может вызываться несколько раз:

1. При повторной попытке обработать транзакцию
2. При изменении логики обработки ошибок транзакций

1. Если нет ошибок или нет id транзакции (запуск после инициализации)
   • Заполнить таблицу транзакций для обработки, добавить столбец "Статус".
   • Если в очереди нет транзакций - Вызвать бизнес исключение "Отсутствуют новые транзакции для обработки".
2. Если есть транзакция на обработке и ошибка (перезапуск приложений для повторной попытки обработки транзакции) - нет действий.
3. Выполнить общие действия - PreProcess.

Ошибка записывается out параметром блока Catch в переменную exc_main для последующей обработки. Источник ошибки перезаписывается отдельным шагом блока Catch для корректного вывода скрипта\шага ошибки.

• Если есть ошибка и ID транзакции не null (перезапуск) - переход в STATE 4: Обработка/создание транзакции
• Если есть ошибка и ID транзакции null - переход в STATE 5: Завершение
• Нет ошибок - переход в STATE 3: Получение данных транзакции

Блок предназначен для извлечения следующей транзакции для обработки. По итогу работу извлекается значение и ID транзакции.

Если получен сигнал остановки из PIX Master - ID элемента очереди - null

Ошибка записывается out параметром блока Catch в переменную exc_main для последующей обработки. Источник ошибки перезаписывается отдельным шагом блока Catch для корректного вывода скрипта\шага ошибки. str_transactionID устанавливается в null.

• Если есть ID транзакции - переход в STATE 4: Обработка/создание транзакции
• Если нет ID транзакции - переход в STATE 5: Завершение

В данной блоке описывается основная бизнес логика процесса обработки транзакции. В начале данного блока значение переменной exc_main сбрасывается. В случае успешной работы скрипта Process.pix - транзакции устанавливается статус Обработано. Блок логируется с указанием ID текущей транзакции.

Ошибка записывается out параметром блока Catch в переменную exc_main для последующей обработки. Источник ошибки перезаписывается отдельным шагом блока Catch для корректного вывода скрипта\шага ошибки. Если превышено количество перезапусков транзакции - транзакции проставляется статус с соответствующим типом ошибки (Business\System).

• Если ошибка при обработке транзакции:
  • Если количество перезапусков превышено - завершение приложений, выполнение PreProcess, переход в STATE 3: Получение данных транзакции.
  • Если количество перезапусков не превышено - закрыть приложения, переход в STATE 2: Общие действия для всех транзакций для повторной обработки.
• Если нет ошибки при обработке транзакции:
  • Если превышено максимальное количество транзакций для обработки - переход в STATE 5: Завершение.
  • Если не превышено максимальное количество транзакций для обработки - переход в STATE 3: Получение данных транзакции.

Блок предназначен для завершения работы робота, закрытия приложений, удаления временных файлов, отправки отчетов и обработки критической ошибки при ее наличии.

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

Ошибка записывается out параметром блока Catch в переменную exc_main для последующей обработки. Источник ошибки перезаписывается отдельным шагом блока Catch для корректного вывода скрипта\шага ошибки.

При наличии переданной ошибки из других состояний, в блоке Finally происходит вызов исключения с соответствующим содержанием и типом для отображения ошибки в PIX Master.

Таким образом, если критическая ошибка возникнет на любом этапе работы проекта, блок STATE 5: Завершение выполнит финальные действия, закроет все приложения и вызовет ошибку.

Блок является последним этапом работы робота и не имеет переходов в другие состояния.

Скрипт используется для создания проектных папок, чтения конфигурационного файла и прочих настроек.

По умолчанию, скрипт создает следующие папки:

Файл Config.xlsx используется для хранения конфигурационных данных робота.

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

При пустом значении - используются данные напрямую из Config.xlsx

В зависимости от указанного типа, данные записываются в словари dict_config и dict_secureData:

Лист Settings Предназначен для определения общих конфигурационных данных под все типы информационных сред разрабатываемого проекта.

Лист Data_Separation Предназначен для разделения конфигурационных данных под каждую информационную среду (PROD, PREDPROD, TEST).

Лист Settings

Лист Data_Separation

Результат работы скрипта:

Значения не зависимые от параметров запуска bool_isProd,bool_isPredProd

bool_isProd - true, bool_isPredProd - true/false

bool_isProd - false, bool_isPredProd - true

bool_isPredProd - false, bool_isProd - false

Ошибка передается на уровень выше.

При указании параметров bool_isProd - false и bool_isPredProd - false, читаются данные столбца Значение_Test

Скрипт "убивает" в активной пользовательской сессии запущенные процессы из списка. Список названий процессов передается с помощью параметра скрипта - list_processesToKill.

Если передать пустой список - завершатся все процессы, определенные в скрипте.

Названия процессов некоторых приложений:

Ошибка передается на уровень выше. Скрипт не выдает ошибку при попытке закрыть несуществующий процесс.

Скрипт для отправки уведомлений.

В скрипт добавлены три типа уведомлений, которые регулируются параметром int_notifyType. Каждый тип уведомлений отправляет сообщение определенной группе пользователей. Разработчик по своему усмотрению может добавлять дополнительные типы уведомлений, связывая с активностью Условный оператор новые контейнеры.

Настройки по умолчанию

В аргументе dict_config можно передавать любую предварительно добавленную в словарь информацию. Например, текст ошибки или уведомления, адресатов рассылки, тему письма и т.д.

Настройки по умолчанию

Вложения для отправки передаются с помощью параметра list_attaches, в котором необходимо указать пути к файлам/папкам для отправки.

Дополнительно, к отправке сообщения можно добавить скриншот экрана, установив значение bool_takeScreenshot - true.

Ошибка передается на уровень выше. Если указан несуществующий тип уведомления скрипт выдает ошибку.

Сохранение скриншота по заданному шаблону. Шаблон по умолчанию : Тип_Дата_Время

Ошибка передается на уровень выше.

Скрипт используется для создания транзакций. По умолчанию создается таблица dt_transactions.

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

Скрипт для получения данных транзакции из таблицы dt_transactions. Выполняется поиск первой транзакции, которая имеет пустой статус.

Идентификатор транзакции - порядковый номер найденной строки (начиная с 1..).

Найденной транзакции устанавливается статус "В обработке", если транзакцию не удалось найти - передается идентификатор транзакции - null.

Ошибка передается на уровень выше.

Скрипт предназначен для выполнения подготовительных общих действий, которые необходимо сделать перед стартом скриптов CreateTransactions.pix, Process.pix. В PreProcess.pix можно выполнять вход во все системы, участвующие в процессе, а также выполнять, например, считывание шаблонных файлов, определяющих работу бизнес-процесса.

Инициализацию различных систем рекомендуется выполнять в активности Try\Fix.

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

Скрипт для выполнения обработки одной транзакций. В данный скрипт необходимо добавить все действия, по обработке транзакции.

Ошибка передается на уровень выше. Если количество попыток выполнения скрипта превышает максимально допустимое - пользователи получают уведомление.

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

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

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

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

По умолчанию скрипт добавляет в таблицу транзакций колонку "Статус" и заполняет после обработки каждой транзакции. Данный отчет сохраняется в папку "Results" для последующего анализа\отправки пользователям.

В случаях, когда данные для запуска в продуктивной и тестовой среде отличаются (например при разработке необходимо использовать тестовый SAP, отдельную почту и т.п.) рекомендуется указывать данные в Config.xlsx в специальных столбцах.

При запуске робота, взависимости от значений параметров запуска, в переменной dict_config будут храниться значения из соответствующих столбцов листа Data_Separation.

Для отправки сообщений различного вида рекомендуется использовать скрипт Notification.pix, по необходимости можно изменить логику, добавить новый тип уведомлений.