ROBIN Player

ROBIN Player - приложение, пользовательский интерфейс ROBIN Robot, обеспечивает управление локальными запусками роботов. Модуль может запускать сценарий по настроенному расписанию, по команде, полученной от ROBIN Agent или от пользователя (ручной запуск). Роботы исполняются локально, на той же машине и УЗ, на которой установлен модуль.

Далее в этом разделе описывается использование ROBIN Robot в среде операционных систем MS Windows.

Работа с модулем ROBIN Player

Для нормальной эксплуатации программных роботов должно быть обеспечено бесперебойное питание технических средств, на которых он функционирует, и обеспечена соответствующая стандартам хранения носителей и эксплуатации АРМ температура и влажность воздуха. Если на машине не настроен AutoLogon, то в случаях, когда машину выключили или перезагрузили необходимо вручную зайти на неё, убедиться в том, что запустился агент (при необходимости выполнить Kill.Robin.Agent.exe, а затем Robin.Agent.exe).

Расположение этих программ будет зависеть от режима установки:

Режим установки Вид значка на рабочем столе Путь до каталога, где находятся программы
Установка «для всех» (у ярлыков будет имя AllUsers) ../_images/AllUser.png С:/Program Files/Robin Platform/2.0.0/Agent/
Установка «для себя» (у ярлыков будет имя CurrentUsers) ../_images/CurrUser.png %USERPROFILE%/AppData/Local/Programs/Robin Platform/2.0.0/Agent

Необходимо убедиться, что приложение Robot Player запущено – значок приложения должен присутствовать в трее.

При необходимости, запустите ROBIN Robot Player вручную, кликнув дважды по ярлыку программы на рабочем столе.

Запуск робота через ROBIN RobotPlayer

Для запуска готового робота (файл с расширением «.robin-robot») необходимо выполнить ряд действий.

Вначале откройте ROBIN RobotPlayer. Для этого кликните по иконке RobotPlayer в трее, откроется окно плеера.

В случае, использования RobotPlayer версии Enterprise, вам потребуется авторизация под конкретной учетной записью:

Когда используется доменная аутентификация, пароль при входе в RobotPlayer вводить не нужно, права доступа будут проверены автоматически.

От версии RobinPlayer зависит, какие роботы отображаются На вкладке «Каталог», доступные для запуска:

Версия RobotPlayer Доступные роботы для запуска
Standalone Только локальные роботы, хранящиеся на АРМ, загруженные пользователем в плеер
Enterprise Все роботы, на которые у пользователя есть права и они сохранены в хранилище

Описание кнопок управления ROBIN RobotPlayer приведено в таблице

Кнопки RobinPlayer Описание функционала кнопок
../_images/P9.png Добавление новых роботов в каталог из хранилища
../_images/P11.png Отключение/включение расписания
../_images/P30.png Настройка расписания запуска робота
../_images/P31.png Запуск робота вручную
../_images/P12.png Редактирование расписания запуска роботов
../_images/P5.png Приостановка работы робота (поставить выполнение сценария на паузу)
../_images/P4.png Остановить выполнение робота (прервать работу)
../_images/P13.png Удаление расписания
../_images/P14.png Обновление созданных изменений в каталоге
../_images/P15.png Запуск планировщика задач Windows
../_images/P7.png Поиск роботов по названию
../_images/P8.png Добавление роботов в закладки (избранное)

Перейдите на вкладку «Каталог роботов». В нем отображаются загруженные в каталог и готовые к запуску роботы. В этой вкладке есть возможность запустить роботов доступных текущего из хранилища. Чтобы добавить нового робота в каталог, нажмите кнопку добавления новых роботов в каталог из хранилища:

Выберите программного робота (файл должен иметь расширение robin-robot) в папке, где он был сохранен:

Выбранный робот отобразится в каталоге ROBIN RobotPlayer:

Для запуска робота в ручном режиме нажмите кнопку запуска робота:

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

Откроется окно, в котором можно отредактировать расписание запуска, перезапуска робота, периодичности и другие параметры запуска:

Для активации разделов настройки передвиньте соответствующий бегунок в состояние «Включено», настройте необходимые параметры. Для завершения нажмите кнопку «Обновить».

Описание разделов настройки расписания

Раздел «Запуск»

Предназначен для настройки даты и времени запуска робота. Для настройки опции «Запуск» (дата и время запуска), необходимо нажать на кнопку, а затем с помощью «календаря» выбрать дату и время запуска робота.

Раздел «Перезапуск»

Предназначен для настройки интервала и количества повторных перезапусков робота. Для настройки опции «Перезапуск» необходимо перевести переключатель в режим «Включено», задать интервал повторения, при необходимости перевести переключатель «Повторять в течение» в режим «Включено» и задать количество повторений в интервал времени.

Раздел «Периодичность»

Предназначен для настройки периодичности запуска робота (еженедельной, ежемесячной, ежедневной). Для настройки опции «Периодичность» необходимо перевести переключатель в режим «Включено», а затем выбрать периодичность запуска – ежедневно, еженедельно (далее необходимо выбрать день недели) или ежемесячно (далее необходимо выбрать день месяца).

Раздел «Запускать до»

Предназначен для настройки даты и времени, до которой необходимо запускать робота. Для настройки опции «Запускать до» необходимо перевести переключатель в режим «Включено», а затем нажать на кнопку календаря и задать дату и время, до которой необходимо запускать робота.

Раздел «Дополнительно»

Настройки раздела используются для выбора правила при выполнении задачи. Функционал по выбору правила аналогичен данному функционалу в планировщике задач. Доступны правила:

  • Не запускать новый экземпляр
  • Запускать новый экземпляр
  • Ставить новый экземпляр задания в очередь
  • Остановка текущего задания

По умолчанию установлено значение «Не запускать новый экземпляр».

Раздел «Параметры запуска»

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

Логирование предполагает возможность установки нескольких уровней, что позволяет варьировать количество сохраняемой в логах.

Требование установки входных данных может быть установлено в Техническом задании на настройку и внедрение данного программного робота. Если это так, следуйте этим требованиям, внесите данные в окно «Data» до запуска робота.

Для обновления расписания запуска робота, необходимо нажать на кнопку «Обновить», для отмены созданного расписания – на кнопку «Отмена».

Робот будет запущен по расписанию.

Запуск робота посредством командной строки

Готовый программный робот также может быть запущен с помощью командной строки. Для такого запуска можно использовать только роботы, файлы которых имеют расширение robin-robot.

В случае, если робот имеет входные параметры необходимо подготовить xml-файл с параметрами, которые будут переданы роботу.

Откройте командную строку, нажав комбинацию клавиш Win+R и в появившемся окне введите «cmd», нажмите Enter (также командную строку можно открыть, введя в поиске windows cmd.exe).

В командной строке укажите полный путь до программы RobotPlayer.exe, далее в параметрах командной строки укажите путь до робота и путь до xml-файла с параметрами (если он требуется) в формате:

«%USERPROFILE%AppDataLocalProgramsRobinPlatform2.0.0RobotPlayerRobotPlayer.exe» -r «путь до готового робота» -p «путь до файла с параметрами»

Пример ввода данных:

Подтвердите запуск робота нажатием клавиши «Enter». Начнется выполнение программного робота. В приложение ROBIN RobotPlayer на вкладке «Запущенные» появится информация о выполнении запускаемого робота:

В процессе работы робот может остановлен пользователем. Для досрочного завершения работы робота необходимо нажать на кнопку «стоп»: стоп

Для приостановки выполнения робота (поставить выполнение сценария на паузу) необходимо нажать кнопу «пауза»: пауза

Просмотр истории запусков роботов

На вкладке «История запусков» можно посмотреть историю отработавших роботов.

Эта возможность доступна для ROBIN RobotPlayer версии Standalone. Для пользователей версии Enterprise эта опция недоступна (вкладка «История запусков» отсутствует). Для этой версии, вся история запусков отображается в интерфейче оркестротора.

Для просмотра доступен следующий функционал:

Фильтрация по дате запуска.

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

Поиск по наименованию запущенного ранее робота.

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

Кнопка сброса всех установленных фильтров.

Поле с информацией о запущенном роботе (таблица), которое включает в себя следующие столбцы:

  • «Дата и время» - отображается дата и время каждого действия в схеме робота.
  • «Сообщение» - отображает наименование действия, начало действия, конец действия, либо ошибку в действии.
  • «Параметр» - отображает параметры, имеющиеся в действии на входе, а также результаты, полученные на выходе.
  • «Значение» - отображает значения, внесенные в параметры, и значения, полученные в результатах.

Отображение статуса выполнения робота на вкладке «История запусков».

Если робот запущен в данный момент, то в строке отсутствует символ.

После завершения его работы в истории, напротив записи появится соответствующий символ:

Символ Значение
../_images/ok.png Робот был завершен без ошибок
../_images/exclamation.png Во время работы робота произошла ошибка
../_images/stop_robot.png Робот был остановлен вручную на вкладке «Запущенные», во время его работы

Настройка информирования о результатах выполнения робота

Для эффективного отслеживания результатов выполнения роботов, в приложении ROBIN RobotPlayer предусмотрена возможность отправки писем, с отчетами о выполнении робота. Доступна отправка результатов успешного и неуспешного выполнения процесса.

Чтобы настроить отправку сообщений, а также язык интерфейса ROBIN RobotPlayer, нажмите кнопку со значком шестеренки, в левом нижнем углу интерфейса программы.

К письму с отчетом можно прикрепить лог выполнения процесса и запись видео с экрана последних секунд выполнения робота. Длительность записи видео может быть изменена.

Для настройки отправки писем при завершении выполнения сценария роботом необходимо заполнить поля в разделе «Настройки соединения с почтовым сервером»:

  • Сервер
  • Порт
  • От кого
  • Логин
  • Пароль

Если требуется использовать SSL/TLS необходимо перевести бегунок во включенное состояние.

В разделе «Список получателей уведомлений о выполнении роботов» есть возможность добавления почтовых адресов при успешных выполнениях и неуспешных. Для добавления адресов необходимо нажать на кнопку:

В письме, которое робот отправит по завершению выполнения (успешно / неуспешно), содержится следующая информация (пример):

Письмо при ошибке: Письмо при успешном выполнении:
../_images/mistake.png ../_images/success.png

Для прикрепления лога к письму необходимо передвинуть бегунок во включенное состояние.

Для записи и отправки вместе с отчетом видео последних секунд работы робота (по умолчанию 10 секунд) необходимо передвинуть бегунок во включенное состояние.

Для сохранения изменений необходимо нажать на кнопку «Сохранить».

Примечание

Особенности записи видео в ROBIN RobotPlayer:

  • По умолчанию длительность видеозаписи составляет 10 секунд, это значение можно изменить в поле «Длительность»;
  • Записанное видео пакуется в архив с расширением .lzma, в архиве видеофайл сохраняется без расширения;
  • Название архива и название файла совпадает с названием запущенного робота;
  • Для просмотра видео необходимо распаковать файл и добавить ему расширение .avi;
  • Качество записи составляет 8 кадров в секунду при 256 цветах, видео сжато;
  • На видео будет отображен весь экран последних n секунд работы робота;
  • При разрешении 1900х1600 размер архива составит от 300 кб до 1 мб;
  • Процессор не грузится во время записи, запись идет в памяти, жесткий диск задействуется только при сохранении;
  • Видео со всего запуска хранятся в папке %USERPROFILE%/AppData/Local/Robin/PlayerLogs/Video (пока размер содержимого папки меньше 1 ГБ).

Статус агента

В кружке в буквой «А» отображено информирование пользователя о статусе агента. Актуально для версий: Standalone, Enterprise, Cloud.

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

Когда у агента случается ошибка «Произошла ошибка при подключении к stateful сервису: Не удалось подключиться к RabbitMq»,приложения (студия, плеер, rmc) ничего об этом не знают. Для приложений агент доступен и работает нормально. Однако, запустить роботов мы не сможем и пользователь не понимает что происходит.

Варианты отображения информирования пользователя о статусе агента.

Standalone:

  • Зеленый - плеер подключен к агенту.
  • Серый - плеер не подключен к агенту. Надо перезапустить агент.

EnterpriseCloud:

  • Зеленый - плеер подключен к агенту, агент подключен к серверу.
  • Серый - плеер не подключен к агенту. Нажмите для переподключения к агенту. Или перезапустите агент.
  • Красный - плеер подключен к агенту, агент не подключен к серверу. Переподключается сам. Попытка раз в минуту.
  • Желтый - плеер подключена к агенту, переподключается к серверу.

Действия при возникновении незапланированных ошибок

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

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

Для анализа причин появления ошибки, рекомендуется выполнить действия:

  • Провести анализ логов выполнения робота;
  • Убедиться, что все настройки перед запуском робота выполнены верно;
  • Убедиться, что файлы, с которыми работает робот, имеют структуру, согласованную на этапе реализации робота;
  • Убедиться, что программы, с которым работает пользователь, установлены и не изменили интерфейс;
  • Убедиться, что почтовый сервис работает корректно (в случае, когда он используется роботом);
  • Убедиться, что запущены компоненты ROBIN: Agent и RobotPlayer;
  • Проверить срок действия лицензии.

Log-файлы робота

Логирование работы роботов выполняется в автоматическом режиме. Файлы с логами размещаются каталоге:

%LocalAppData%/Programs/Robin Platform/2.0.0/RobotLogs

Логи работы ROBIN RobotPlayer располагаются в каталоге:

%USERPROFILE%/AppData/Roaming/Robin Platform/2.0.0/RobotPlayer/Logs

Для просмотра логов можно воспользоваться любым приложением, которое позволяет просматривать с txt-файлы.