Skip to Content
Primo RPA RobotУстановка и запускЗапуск из командной строки

Запуск из командной строки

Запустить attended-робота можно двумя способами: из командной строки или с помощью утилиты Primo RPA Robot Runner. Отличия следующие:

  • При использовании робота из командной строки запуск задач осуществляется вручную, поскольку Primo RPA Robot не поддерживает запуск по расписанию.
  • Утилита Robot Runner предоставляет пользователю удобный графический интерфейс и поддерживает запуск задач по расписанию.

Лицензия

⚠️

Важно. Перед запуском Primo RPA Robot требуется запросить лицензию.

Вне зависимости от того, какой способ запуска вы выбрали, сначала потребуется запросить лицензию на программу Primo RPA Robot. Без нее использование робота невозможно. Лицензия запрашивается только через утилиту Robot Runner, описание запроса см. здесь.

Типы аутентификации с Оркестратором

ℹ️

Доступные типы аутентификации: - winauth - аутентификация Windows (для доменных пользователей) - keycloakauth - аутентификация через Keycloak

При использовании winauth пароль не передается в открытом виде в командной строке.

Ключ лицензии (key=)

Важно о параметре key=: - Представляет собой любой новый GUID - Для задач, запускаемых из Раннера, ключ сохраняется в runner_config.xml - При постоянном использовании через Раннер ключ остается неизменным - Рекомендуется запомнить или сохранить значение ключа, так как он используется для идентификации робота в Оркестраторе и поиска соответствующих записей в логах

Конфигурация для получения лицензии от Оркестратора

Корректная настройка (работает):
  • Снять чекбокс “Без Оркестратора”
  • Выбрать тип “Клиентский” в настройках задачи
  • В параметрах запуска будет автоматически добавлен key=
Некорректная настройка (не работает):
  • Установлена галка “Без Оркестратора” в настройках задачи
  • Отсутствует параметр key= в аргументах запуска

Как запустить робота через терминал

Для запуска Primo RPA Robot из командной строки — запустите его с помощью ярлыка на рабочем столе или из меню Пуск.

Программа Primo RPA Robot обладает минимальным графическим интерфейсом:

alt

Кнопка alt служит для очистки текста консоли робота. Иконка Primo RPA Robot отображает версию программы.

Примеры рабочих конфигураций

Запуск с подключением к Оркестратору (получение лицензии):
Primo.Robot.exe instantStart exitOnSuccess attended key=dbac2a0d-6600-4472-8b88-32d4152632aa "name=[Default]" projid=12 "projname=Hello_world (v.0)" attendededition=Standard startuposition=Tray "orcaddr=https://10.0.0.122:44392/" orcuser=robot orcpassnocrypt=Qwel231@# logType=Text logMsgTypes=Error|Info|Test lang=RU useOrchLocal=0

Полный список параметров для Windows:

ℹ️

Примечание. Названия аргументов можно писать в любом регистре.

⚠️

Важно. При запуске робота без Orchestrator (с параметром noOrchestrator) параметр lang является обязательным и должен указываться большими буквами (RU/EN). Иначе робот завершит работу с ошибкой.

  • aliveinterval=: интервал отправки запросов KeepAlive.
  • apppriority=: приоритет приложения. Доступные значения: Normal/Idle/High/RealTime/BelowNormal/AboveNormal.
  • attended: признак attended.
  • attendededition=: редакция attended робота. Доступные значения: Enterprise/Standard/Robot_Desktop.
  • cache: кешировать отладчик.
  • CloseRdp: автоматически корректно завершать сессию RDP на старте.
  • debugedition=: издание для отладки. Доступные значения: Studio/Robot/Orchestrator/Miner/Robot_Standard/Robot_Desktop/Testing.
  • debugger: режим отладки.
  • debugoptions=: настройки отладки. Доступные значения: NoTrace.
  • engver=: версия ядра робота. Доступные значения: v1 и v2. Использование второй версии (v2) позволяет ускорить загрузку процессов и повысить производительность при работе с высоконагруженными процессами.
  • exitonsuccess: закрыть робота по завершении выполнения проекта.
  • hle: подсвечивать элементы.
  • instantStart: стартовать запуск проекта, как только робот будет загружен.
  • key=: ключ Оркестратора (произвольный GUID). Значение этого ключа используется для идентификации робота в Оркестраторе и поиска соответствующих записей в логах.
  • lang=: языки интерфейса. Регистр значения важен - используйте заглавные буквы: RU или EN
  • lockspath=: путь к файлам синхронизации выполнения.
  • logCustomToFile: признак записи пользовательских событий в журнал.
  • loginterval=: настройки для отправки логов в Оркестратор. Частота опроса в миллисекундах.
  • logmaxcount=: настройки для отправки логов в Оркестратор. Максимальный размер очереди.
  • logmaxinterval=: настройки для отправки логов в Оркестратор. Время в миллисекундах, после которого отправляются сообщения, игнорируя размер пачки.
  • logMsgTypes: типы журналируемых событий (Error, Info, Debug, Network). Для указания нескольких используется символ | (например, Error|Info|Debug).
  • logpacksize=: настройки для отправки логов в Оркестратор. Размер пачки для отправки.
  • logToFile: признак записи журнала в файл (папка Log).
  • logType: тип журнала (Text, Csv).
  • minthreads=: минимальное кол-во потоков.
  • mock: использовать заглушки.
  • name=: имя робота.
  • noConsole: отключает отображение журнала в консоли.
  • noorclogs: признак того, что не надо отправлять логи в оркестратор.
  • noOrchestrator: режим работы в отсутствии Оркестратора (обязателен, если робот запускается вручную).
  • ocver=: версия чистого кода. Доступные значения: v1 и v2.
  • operationkey=: OperationKey - идентификатор операции (когда робот запускается из Оркестратора).
  • orcaddr=: адрес оркестратора.
  • orcpass=: пароль оркестратора (зашифрованный).
  • orcpassnocrypt=: пароль оркестратора (не зашифрованный).
  • orcuser=: логин оркестратора.
  • pass=: пароль.
  • precompile: режим сценария.
  • projid=: ID проекта.
  • projname=: наименование проекта.
  • projPath: путь к папке выполняемого проекта.
  • pushstatus: модель push-status.
  • robotedition=: редакция робота. Доступные значения: Enterprise/Standard/Robot_Desktop.
  • robotlogsaddr=: адрес сервиса приема логов.
  • robotport=: порт отладки робота.
  • RunConfig: тип конфигурации запуска (для переменной _Workflow.RunConfig). Возможные варианты: None, Debug, Release.
  • RunConfigCustom: тип конфигурации запуска (для переменной _Workflow.RunConfigCustom).
  • sandbox: признак песочницы.
  • sendvars: отправлять значения переменных.
  • seqPath: путь к главной последовательности проекта.
  • sleepbeforeclose=: задержка перед закрытием робота.
  • startuposition=: вариант отображения робота на старте. Возможные варианты: Normal, Minimized, Maximized, Tray.
  • StartupPosition: вариант отображения робота на старте. Возможные варианты - Normal (стандартный), Minimized (свернутый), Maximized (во весь экран), Tray (свернут в системный трэй).
  • studioport=: порт отладки Студии.
  • tenantid=: Tenant ID.
  • threadsсount=: кол-во потоков.
  • threadpriority=: приоритет потока. Доступные значения: Lowest/BelowNormal/Normal/AboveNormal/Highest.
  • threadstartindex=: индекс первого потока.
  • user=: логин.
  • videoMaxLs=: видеозапись — максимальная продолжительность.
  • videobr=: видеозапись — битрейт.
  • videofr=: видеозапись — кадры в секунду.

Параметры для операционной системы Linux:

  • aliveinterval=: интервал отправки запросов KeepAlive.
  • apppriority=: приоритет приложения. Доступные значения: Normal/Idle/High/RealTime/BelowNormal/AboveNormal.
  • asyncattendedlicense: для получения attended лицензии асинхронно.
  • attended: признак attended.
  • attendededition=: редакция attended робота. Доступные значения: Enterprise/Standard/Robot_Desktop.
  • cache: кешировать отладчик.
  • debugedition=: издание для отладки. Доступные значения: Studio/Robot/Orchestrator/Miner/Robot_Standard/Robot_Desktop/Testing.
  • debugger: режим отладки.
  • debugoptions=: настройки отладки. Доступные значения: NoTrace.
  • engver=: версия ядра робота. Доступные значения: v1 и v2. Использование второй версии (v2) позволяет ускорить загрузку процессов и повысить производительность при работе с высоконагруженными процессами.
  • exitonsuccess: закрыть робота по завершении выполнения проекта.
  • hasui: наличие UI окна у робота.
  • instantStart: стартовать запуск проекта, как только робот будет загружен.
  • key=: ключ Оркестратора (произвольный GUID). Значение этого ключа используется для идентификации робота в Оркестраторе и поиска соответствующих записей в логах.
  • lang=: языки интерфейса. Доступные значения: RU/EN.
  • lockspath=: путь к файлам синхронизации выполнения.
  • logCustomToFile: признак записи пользовательских событий в журнал.
  • loginterval=: настройки для отправки логов в Оркестратор. Частота опроса в миллисекундах.
  • logmaxcount=: настройки для отправки логов в Оркестратор. Максимальный размер очереди.
  • logmaxinterval=: настройки для отправки логов в Оркестратор. Время в миллисекундах, после которого отправляются сообщения, игнорируя размер пачки.
  • logMsgTypes: типы журналируемых событий (Error, Info, Debug, Network). Для указания нескольких используется символ | (например, Error|Info|Debug).
  • logpacksize=: настройки для отправки логов в Оркестратор. Размер пачки для отправки.
  • logToFile: признак записи журнала в файл (папка Log).
  • logType: тип журнала (Text, Csv).
  • minthreads=: минимальное кол-во потоков.
  • mock: использовать заглушки.
  • name=: имя робота.
  • noConsole: отключает отображение журнала в консоли.
  • noOrchestrator: режим работы в отсутствии Оркестратора (обязателен, если робот запускается вручную).
  • operationkey=: идентификатор операции (когда робот запускается из Оркестратора).
  • orcaddr=: адрес Оркестратора.
  • orcpass=: пароль Оркестратора (зашифрованный).
  • orcpassnocrypt=: пароль Оркестратора (незашифрованный).
  • orcuser=: логин Оркестратора.
  • precompile: режим сценария.
  • projid=: ID проекта.
  • projname=: наименование проекта.
  • projPath: путь к папке выполняемого проекта.
  • pushstatus: модель push-status.
  • robotedition=: редакция робота. Доступные значения: Enterprise/Standard/Robot_Desktop.
  • robotlogsaddr=: адрес сервиса приема логов.
  • RunConfig: тип конфигурации запуска (для переменной _Workflow.RunConfig). Возможные варианты: None, Debug, Release.
  • RunConfigCustom: тип конфигурации запуска (для переменной _Workflow.RunConfigCustom).
  • sendvars: отправлять значения переменных.
  • seqPath: путь к главной последовательности проекта.
  • sleepbeforeclose=: задержка перед закрытием робота.
  • startuposition=: вариант отображения робота на старте. Возможные варианты - Normal (стандартный), Minimized (свернутый), Maximized (во весь экран), Tray (свернут в системный трэй).
  • tenantid=: Tenant ID.
  • threadsсount=: кол-во потоков.
  • threadpriority=: приоритет потока. Доступные значения: Lowest/BelowNormal/Normal/AboveNormal/Highest.
  • threadstartindex=: индекс первого потока.

Пример для Linux:

Primo.Robot instantStart exitOnSuccess noOrchestrator logType=Csv "seqPath=/home/user/Project/Sequence.ltw" "projPath=/home/user/Project/"

Дополнительные команды для Linux

Для операционной системы Linux также доступна команда, с помощью которой робот может вернуть список всех доступных активностей в Студии:

./Primo.Robot ActivitiesList

Команда поддерживает следующие аргументы:

  • -G, —grouping: Включить группировку активность
  • -F, —write-in-file: Вывести результат выполнения команды в файл
  • —output-directory: Путь к итоговому файлу. По умолчанию используется текущая папка + ActivitiesList.txt
  • —help: Показать текст справки

Пример:

./Primo.Robot ActivitiesList -G -F --output-directory=/tmp/ActivitiesList.txt

Решение проблем

Если задача не запускается:

  • Проверьте, что снята галка “Без Оркестратора” в настройках задачи
  • Убедитесь, что в параметрах запуска присутствует key= (GUID)
  • Сохраните значение ключа key= для поиска записей в логах Оркестратора
  • Проверьте корректность адреса оркестратора и учетных данных
  • Убедитесь, что пользователь зарегистрирован у вендора

При возникновении проблем с лицензированием рекомендуется проверить настройки типа подключения к Оркестратору и убедиться, что используется корректная конфигурация для attended-режима.

Запрос лицензии DesktopPrimo RPA Robot Runner