Environment requirements for installation

Orchestrator requirements

Требования к окружению для установки

Требования к Оркестратору

...

1. Orchestrator must be configured and running on your local network, and its network accessibility for workstations must be ensured. Check the URL of the Orchestrator with your system administrator.
2. Version

1.  2.5.0
   

...

Требования к рабочей станции

...

1. Availability of a CA-validated certificate included in the trusted certificates on workstations. Self-signed certificates can only be used for test runs and do not guarantee reliable operation

Workstation requirements

1. RAM not less than 4Gb, free disk space from 5 Gb

2. RED OS 7.3.2 / 64,

...

Учетная запись с правами администратора (sudo). Внимание. Прямая установка в сеансе root (когда в терминале отображается подсказка root@<host>) может привести к непредсказуемым последствиям и потому недопустима. Проводите установку в сеансе пользователя, у которого доступно выполнение команд через sudo.

...

Устойчивое подключение к официальным репозиториям RED OS (доступ в интернет либо к локальным зеркалам репозиториев пакетов RED OS)

1. with basic security profile settings (no Windows domain entry)

2. Account with administrator rights (sudo).

   Примечание
   title Attention!
   Direct installation in the root session (when the root@<host> prompt is displayed in the terminal) can lead to unpredictable consequences and is therefore unacceptable. Do the installation in the session of a user who has access to sudo commands.

   
   

3. Stable connection to official RED OS repositories (access to the Internet or local mirrors of RED OS package repositories)

4. To work with browser automation - you need to make sure you have one of the browsers, if necessary - install one of the supported ones in the current release

...

1. :

• Yandex-Browser 22.9

• Yandex-Browser 22.5

• Yandex-Browser 22.7

• Yandex-Browser 23.3

• Chromium 94

• Chromium 101

• Firefox 31

• Firefox 30

Примечание. Если в комплекте поставки присутствуют роботы, разработанные по заказу, то для работы этих роботов может потребоваться определенная версия браузера (в этом случае необходимо проконсультироваться с разработчиком роботов).

Процесс установки

Необходимые материалы и информация:

...

Installation process

Required materials and information:

1. Archive with distribution packages in *.tar.gz

...

1.  format.
2. The Agent configuration file with settings is Robin.Agent.

...

1. cfg (

...

1. optional, but it will simplify settings after installation, you can check with the Robin Orchestrator administrator).
2. The value of the ClientSecret key for connection to the Orchestrator if it differs from the value in Robin.Agent.cfg

...

1. or this file is not provided (this data is optional, but it will simplify the settings after installation, you can check with the Robin Orchestrator administrator).
2. The host address of the Robin Orchestrator installed on your corporate network (available from your Robin Orchestrator administrator). The host address must be in full format with the scheme (http/https) and port if different from the standard values for the scheme

...

1. (http - 80, https - 443).

...

1. Example of a valid value: https://orc.robin.corp:8443

Распакуйте полученный архив с фалами дистрибутива в новую директорию внутри вашей домашней директории (например, ~/dist). Для этого откройте в Менеджера файлов директорию с архивом, запустите из него Терминал и выполните командыExtract the archive with the distribution files to a new directory inside your home directory (e.g. ~/dist). To do this, open the directory with the archive in File Manager, launch Terminal from it and execute the commands.

mkdir -p ~/dist

tar -xvzf <имя архива> <archive name> -C ~/dist

Перейдите внутрь директории с распакованным архивомGo inside the directory with the extracted archive.

cd ~/dist

Рекомендуется использовать сценарий автоматической установки и конфигурации.

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

Установка

...

It is recommended that you use the automatic installation and configuration script.

Installation

The following files must be present in the directory, along with the installation packages:

rpa-robin-install-deb-std.sh

rpa-robin-check-user-group.sh

Для установки выполните командуTo install, run the command:

sudo ./rpa-robin-install-redos-ent.sh ./Robin.Agent.cfg <адрес хоста> 

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

Следите за сообщениями на экране. Процесс установки может занять несколько минут.

...

If you were provided only the host address or only the configuration file, specify them as an argument when calling the deployment script (the parameter type is automatically recognized).

Watch the messages on the screen. The installation process may take a few minutes.

During the installation you will be asked for the ClientSecret key. Enter its value if you know it, or press the Enter key immediately to continue the installation without a new key.

Getting ClientSecret for Robin.Agent authentication via Keycloak:

а. Go to the admin panel in Keycloak (atа. Зайти в панель администратора в Keycloak (по адресу https://serverhost:8443/, указать указать свой адрес вместо specify your address instead of serverhost)
Логин/пароль по умолчаниюDefault login/password: admin/Qwerty123

Image AddedImage Removed
b. В выпадающем меню выбрать realm "Robin"Image Removed Select the realm Robin from the dropdown menu.

Image Added

c. Получить Secret для агентаGet Secret for the agent

Select Выбрать Clients → Robin.Agent → Credentials → Client secret

Image RemovedImage AddedImage Removed

Image AddedImage Removed

Image Added

Example of a received textПример полученной записи: BDsArvgg7R9lKXJHe6fSKU4dRB8xBlY4

...

Adding the current user to the rpa-robin

...

group

Once the installation is complete, check to see if the current user is in the rpa-robin group to work with robots. You can use the attached utility to do thisПо окончанию установки проверьте, не присутствует ли текущий пользователь в группе rpa-robin для работы с роботами. Для этого можно воспользоваться приложенной утилитой:

./rpa-robin-check-user-group.sh

Если пользователь не присутствует в группе - вы можете сделать это с помощью командыIf the user is not present in the group - you can do this with the command:

sudo usermod -aG rpa-robin $USER

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

Без участия в группе rpa-robin, пользователь не сможет выполнять роботов.

Внимание. Пользователь окажется в группе только в следующем сеансе, если его учетная запись не была включена в группу rpa-robin в ходе предыдущих инсталляций. Чтобы участие пользователя в группе вступило в силу, необходимо завершить сеанс пользователя в операционной системе и открыть новый сеанс.

Without participation in the rpa-robin group, the user will not be able to execute robots.

Execute the command for initial configuration of drivers for web browsers (executed once for the userВыполнить команду для первоначальной настройки драйверов для web-браузеров (выполняется однократно для пользователя):

cli-robin webdrivers-bootstrap

Если в системе уже существует файл конфигурации, высветится подтверждение о перезаписи. Рекомендуется перезаписать файл после инсталляции платформы.

If a configuration file already exists in the system, a confirmation will be displayed to overwrite the file. It is recommended to overwrite the file after installing the platform.

To get started, run the command in the terminalДля начала работы выполните в терминале команду:

rpa-connector

Минимизируйте окно терминала, не закрывая процесс

Настройка рабочей станции на Оркестраторе

Откройте Web-интерфейс Оркестратора

В случае, если ваша учетная запись не зарегистрирована на Оркестраторе, зарегистрируйте ее. Имя учетной записи на Оркестраторе должно совпадать с именем учетной записи на РЕДОС. При регистрации укажите (как минимум) следующие роли: "Исполнитель задач", "Пользователь Robin Player".

Image Removed

Добавление рабочей станции возможно после установки и запуска Robin Robot на рабочей станции.

Проверьте наличие хоста в списке оркестратора:

Image Removed

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

Image Removed

Image Removed

Проверить соединение хоста и оркестратора можно после нажатия на кликабельное имя хоста, откроется форма с информацией, при этом индикатор состояния под именем хоста должен быть зеленым (Online):

Image Removed

Для более подробной информации о работе с Оркестратором обратитесь к документации на Оркестратор.

Запуск роботов

Локальный запуск роботов (файл робота на рабочей станции)

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

Робот может быть запущен 2 способами:

1. Из файлового менеджера - по клику правой кнопкой - вверху контекстного меню элемент "Открыть в Robin Player"; либо по двойному клику мышкой на пиктограмме файла

2. В терминале: robinplayer <путь к файлу либо имя файла если в текущей директории>

Image Removed

При запуске робота откроется терминальное окно с сообщениями о ходе выполнения. После успешного выполнения окно закроется автоматически, в случае критичной ошибки робота - останется открытым для просмотра, закрыть его можно через сочетание клавиш Ctrl+C

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

Удаленный запуск роботов (файл робота на Оркестраторе)

Обратитесь к документации на Оркестратор

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

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

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

...

Minimize the terminal window without closing the process

Setting up a workstation on Orchestrator

Open the Orchestrator Web interface.

If your account is not registered on Orchestrator, please register it. Your Orchestrator account name must be the same as your RED OS account name. When registering, specify (at least) the following roles: Task Performer, Robin Player User.

Image Added

Adding a workstation is possible after installing and running Robin Robot on the workstation.

Check if the host is in the Orchestrator list:

Image Added

If the host name is not in the list - add it, while selecting your current host account from the account dropdown list.

Image Added

Image Added

You can check the connection between the host and the orchestrator by clicking on the clickable host name, a form with information will open, and the status indicator under the host name should be green (Online):

Image Added

For more information about using Orchestrator, please check the documentation about Orchestrator.

Launching robots

Local launch of robots (robot file on the host)

The versions of the actions used in the robot must be present in the installed platform for the robot to execute successfully.

The robot can be launched in 2 ways:

1. From the file manager - by right-clicking - the item Open in Robin Player at the top of the context menu; or by double-clicking the file icon with the mouse

2. In terminal: robinplayer <path to file or file name if in current directory>

Image Added

When launching the robot, a terminal window with progress messages will open. After successful execution the window will close automatically, in case of a critical robot error it will remain open for viewing, it can be closed using the keyboard shortcut Ctrl+C

Remote robot launch (robot file on Orchestrator)

Refer to the Orchestrator documentation.

Working in a multi-user environment

If several different users are running on the system and launching the same robots, there may be conflicts at the level of temporary files in the shared /tmp directory.

To avoid conflicts, on computers with multiple users, it is recommended to clear the temporary files in the /tmp directory of which after finishing work and before logging out.

The cleanup command:

rm -f /tmp/*.robin*

...

Changing ClientSecret

...

key

If you need to update the key during operation, you can do so in the terminal by typing the commandЕсли в ходе эксплуатации Вам понадобится обновить ключ, вы можете сделать это в терминале, введя команду:

cli-robin setup-secret

Ввод значения маскируется, значение ключа не будет отображаться на экране

Изменение пароля RabbitMQ

Value entry is masked, the key value will not be displayed on the screen

Changing RabbitMQ password

If during operation you need to change the password to connect to RabbitMQ, you can do so in the terminal by typing the commandЕсли в ходе эксплуатации Вам понадобится изменить пароль для соединения с RabbitMQ, вы можете сделать это в терминале, введя команду:

sudo /usr/local/bin cli-robin config-update Agent Admin -k RabbitPassword -v  <значение пароля>

Обновление драйверов браузера

...

<password value>

Updating browser drivers

If it is required to update the browser drivers, it is possible to download the necessary driver version (from the driver or browser developer's resource). The structure of directories with drivers inside the installed Robin platform inside the directory

/opt/RobinPlatform/2.0.0/drivers/browser

...

has the following structure (the directory with the browser name, then the directory with the driver name and version, inside which the driver itself is located):

Image Added

1. Download the driver, unzip if it is archived, place it in a directory named in the format name-version
2. Make sure it is a usable file for everyone
3. Скачать драйвер, распаковать если он заархивирован, поместить в директорию, названную в формате "имя-версия"
Убедиться, что он является исполняемым файлом для всех
4. :
   chmod +x yandexdriver
Скопировать директорию с драйвером по нужному пути, например
5. Сopy the directory with the driver to the desired path, for example:
   sudo 
cp 
6. cp -
a 
7. a yandexdriver-23.3.1.
755  
8. 755  /opt/RobinPlatform/2.0.0/drivers/browser/yandex/
Добавить запись в файл конфигурации
9. Add an entry to the configuration file ~/.robin/env/cfg
по подобию существующих записей в файле (обратите внимание что для версии Yandex в левой части строк указываются только три цифры без точки - например 229 вместо
10.  similar to the existing entries in the file (note that for the Yandex version only three digits without a dot are specified on the left side of the lines - e.g. 229 instead of 22.9.1.1110):

...

Консоль просмотра журнала роботов

Добавлен инструмент для просмотра журналов. На инструментальном стержне вверху окна можно переключиться на вкладки журналов Агента, действий на Java и действий на Python. В таблицу выводится до 1000 последних записей журнала. После запуска робота для загрузки новых записей можно нажать кнопку Update/Обновить.

Image Removed

...

Image Added

Robot log view console

A tool for viewing logs has been added. On the tool bar at the top of the window, you can switch to the tabs for Agent logs, Java actions, and Python actions. Up to 1000 recent log entries are displayed in a table. After starting the robot, you can click the Update button to download new entries.

Image Added

Launch the tool from the command line in a normal user session:

gui-robin

...

Window with color inversion (black background):

gui-robin --dark

Деинсталляция

Uninstallation

If you need to uninstall the Robin Platform, you can use the standard operating system commands В случае необходимости деинсталяции Платформы Робин, можно воcпользоваться штатными командами операционной системы (dnf)Удаление (деинсталляция)

Uninstall:

sudo dnf remove -y rpa-robin-core