Поделиться через


сеанс IA-Connect

IA-Connect — это платформа автоматизации роботизированных процессов RPA, которая добавляет функции RPA из облака в локальные виртуальные машины или через подключения Citrix или Microsoft Remote Desktop RDS. Это модуль для автоматизации среды, сеанса, управления файлами и настройки IA-Connect.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Ultima Labs
URL https://www.ultima.com/ultima-labs
Адрес электронной почты IAConnect@ultima.com
Метаданные соединителя
Publisher Ultima Business
Веб-сайт https://www.ultima.com/ultima-labs
Политика конфиденциальности https://www.ultima.com/privacy-policy
Категории ИТ-операции; Продуктивность

IA-Connect — это платформа автоматизации роботизированных процессов (RPA), которая добавляет функции RPA из Облачных потоков Power Automate в локальные виртуальные машины или через подключения Citrix или Microsoft Remote Desktop (RDS). Соединители IA-Connect предоставляют более 800 действий, что позволяет автоматизировать каждый тип локального приложения непосредственно из Power Automate Cloud Flow. Все действия IA-Connect доступны непосредственно из Power Automate Cloud Flow, обеспечивая простую интеграцию между облачными и локальными приложениями, возможность использовать существующие условия Power Automate, циклы, динамическое содержимое, выражения и обработку исключений в процессах RPA. Использование соединителей IA-Connect также обеспечивает полную историю выполнения и возможность аудита из журнала выполнения потока, а также удаление необходимости в отдельном приложении, консоли или студии для разработки процессов RPA.

Предпосылки

Чтобы использовать любой из соединителей IA-Connect, необходимо установить программное обеспечение IA-Connect. Это бесплатно для тестирования в течение 30 дней, после чего вам потребуется лицензия IA-Connect.

Программное обеспечение IA-Connect состоит из двух основных компонентов:

  • IA-Connect Orchestrator, который является Azure WebApp, который будет размещаться в собственном клиенте Azure. Это обрабатывает маршрутизацию и безопасность потоков RPA на одну или несколько локальных или облачных виртуальных машин.

  • Агент IA-Connect и директор, установленный на виртуальных машинах, где программное обеспечение, которое требуется автоматизировать, доступно. Кроме того, агент IA-Connect может выполняться в сеансе Citrix или Microsoft Remote Desktop Services (RDS), где команды RPA передаются по виртуальному каналу в удаленный сеанс для выполнения. Агент IA-Connect можно запустить из общей сетевой папки и не требует установки.

Доступные соединители IA-Connect

Доступные соединители IA-Connect:

  • динамический код IA-Connect
  • IA-Connect Java
  • JML IA-Connect
  • IA-Connect Мейнфрейм
  • IA-Connect Microsoft Office
  • IA-Connect SAP графический интерфейс пользователя
  • сеанс IA-Connect
  • Пользовательский интерфейс IA-Connect
  • веб-браузер IA-Connect

Получение учетных данных

Чтобы получить лицензию и начать 30-дневную бесплатную пробную версию, отправьте запрос на наш веб-сайт (https://www.ultima.com/IA-Connect/Power-Automate).

После получения пробного запроса мы свяжемся с вами по адресу электронной почты, предоставленному для настройки IA-Connect программного обеспечения и предоставления пробной лицензии. Это полностью многофункциональная пробная версия и позволит протестировать любые из 800 действий во всех 9 IA-Connect соединителях в пределах собственной среды в течение пробного периода.

Начало работы с соединителем

После отправки пробного запроса на IA-Connect вы сможете скачать ZIP-файл, содержащий IA-Connect программное обеспечение и документацию по установке и настройке. Мы также обратитесь к вам, чтобы предложить поддержку и рекомендации по процессу установки по мере необходимости.

Support

В течение пробного периода вы можете обратиться в Ultima Labs (IAConnect@ultima.com) за поддержкой и помощью.

При покупке IA-Connect лицензии вы получите маркеры поддержки, которые можно активировать для обучения или поддержки в Центре технической службы на основе Великобритании (TSC).

Известные проблемы, распространенные ошибки и часто задаваемые вопросы

Наша база знаний содержит ряд статей, охватывающих все известные проблемы, распространенные ошибки, которые могут возникать при использовании соединителей IA-Connect и часто задаваемых вопросов. Это доступно https://support.ultima.com/ultimalabs и учетная запись для доступа к этим ресурсам предоставляется во время IA-Connect пробной версии и при приобретении лицензии IA-Connect.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

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

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ API securestring Ключ API для этого API True
адрес оркестратора IA-Connect струна Укажите адрес оркестратора IA-Connect без компонента HTTP(S) True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

UnZIP-файл

Распакует файл, сжатый с помощью сжатия ZIP.

Wiggle mouse

Перемещает мышь назад и вперед по указанному числу координат. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши.

Блокировка сеанса

Блокирует сеанс, в котором выполняется агент IA-Connect.

Включение IA-Connect следующего прыжка

Включает следующий прыжок, который перенаправит все будущие команды, полученные на агент IA-Connect, запущенный в следующем сеансе прыжка.

Включение наследования безопасности папок

Включает наследование безопасности в папке на компьютере, где запущен агент IA-Connect.

Включено средство чтения с экрана

Возвращает значение, включено ли средство чтения с экрана в сеансе пользователя агента IA-Connect.

Выделение рабочей роли из Orchestrator

Выделяет рабочую роль из IA-Connect Orchestrator. Вы можете запросить рабочую роль по тегу или имени рабочей роли (или ни к тому, ни другому), что позволяет точнее выбрать нужную рабочую роль. После выделения рабочей роли он назначается потоку и будет сообщаться как о выполнении работы. Обратите внимание, что Оркестратор по-прежнему будет рассматривать "Поддерживаемые идентификаторы среды потока", "Поддерживаемые имена потоков" и "Неподдерживаемые имена потоков" при выполнении выделения. Если несколько рабочих ролей соответствуют поиску, будут применяться обычные правила балансировки нагрузки.

Выполнение команды универсального агента IA-Connect

Выполняет универсальную команду агента IA-Connect, передавая аргументы в формате JSON и возвращая выходные данные в формате JSON. Используется для выполнения команд агента, когда директор и инспектор являются более старыми версиями, чем агент, и поэтому не понимает команду.

Дважды слева щелкните мышь в координате

Дважды нажимает левую кнопку мыши в сеансе пользователя агента IA-Connect по указанным координатам. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Дважды щелкните левую кнопку мыши

Дважды щелкает левую кнопку мыши в сеансе пользователя агента IA-Connect.

Добавление заметки в задачу автоматизации Orchestrator

Добавляет заметку к выбранной задаче автоматизации Orchestrator. Эта заметка будет передана исходной системе, связанной с этой задачей автоматизации (например, ServiceNow), и чаще всего используется для добавления сведений в билет. Если задача автоматизации Orchestrator не связана с источником, создается исключение.

Добавление новой задачи автоматизации Orchestrator

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

Добавление новой операции автоматизации Orchestrator

Добавьте новую задачу автоматизации Orchestrator и получите идентификатор операции. Имя конкретной задачи требуется, если задача обрабатывается внешним опрашителем или триггером Orchestrator. Это действие отличается от задачи "Добавление новой задачи автоматизации Orchestrator" (TasksAddNewTaskOperation), в том случае, что она отвечает с идентификатором неугадываемой операции, а не идентификатором угадываемой задачи.

Добавление новой отложенной задачи Orchestrator

Добавьте новую отложенную задачу Orchestrator в очередь, которую можно отслеживать из потока. Задача будет отложена до указанного времени в будущем. Используйте это действие для временной приостановки задачи на определенный период времени (например, если вы ожидаете что-то).

Добавление новой отложенной операции задачи Orchestrator

Добавьте новую отложенную задачу Orchestrator и получите идентификатор операции. Задача будет отложена до указанного времени в будущем. Используйте это действие для временной приостановки задачи на определенный период времени (например, если вы ожидаете что-то). Имя конкретной задачи требуется, если задача обрабатывается внешним опрашителем или триггером Orchestrator. Это действие отличается от "Добавление новой отложенной задачи Orchestrator" (TasksAddNewDeferral), в том случае, что оно отвечает с помощью неугадываемого идентификатора операции, а не идентификатора угадываемой задачи.

Добавление папки в ZIP

ZIPs-файлы в папке в ZIP-файл (сохраняет файлы в архив сжатия).

Добавление разрешения в папку

Добавляет разрешение на папку на компьютере, на котором запущен агент IA-Connect.

Добавление разрешения на файл

Добавляет разрешение на файл на компьютере, на котором запущен агент IA-Connect.

Добавление файла в ZIP-файл

ZIPs a file (сохраняет файл в архив сжатия).

Дождитесь закрытия сеанса IA-Connect по имени

Ожидает закрытия указанного сеанса директора IA-Connect. Это сеанс, в который отправляются команды агенту IA-Connect. Имя будет известно из предыдущего действия "Присоединить".

Дождитесь подключения сеанса следующего прыжка IA-Connect

Ожидает подключения к следующему сеансу прыжка и выполнения агента IA-Connect в следующем сеансе прыжка.

Дождитесь успешного завершения потока агента

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

Доступно ли каталог

Возвращает значение, доступно ли каталог (папка) и ограничивает ли разрешения доступ к нему на компьютере, где IA-Connect агент.

Заблокирован сеанс

Сообщает, заблокирован ли сеанс, в котором запущен агент IA-Connect.

Задание положения графического интерфейса агента IA-Connect

Задает положение на экране графического интерфейса агента IA-Connect в указанное расположение.

Задание уровня журнала агента IA-Connect

Задает уровень ведения журнала агента IA-Connect для указанного значения (1 — самый низкий уровень и 4 — самый высокий).

Закрытие агента IA-Connect

Закрывает агент IA-Connect. Это не влияет на сеанс пользователя, на котором запущен агент IA-Connect.

Замена данных переменных в INI-файле

Обновляет одну переменную в файле INI.

Запись в CSV-файл

Создает CSV-файл на компьютере, на котором запущен агент IA-Connect. CSV-файл создается из коллекции (таблицы) или из таблицы в формате JSON.

Запись в учетные данные пользователя

Записывает имя пользователя и пароль в учетные данные в профиле пользователя в сеансе агента IA-Connect, создавая эти учетные данные, если он не существует. Учетные данные можно просмотреть на панели управления Windows.

Запись текстового файла

Создает текстовый файл на компьютере, где выполняется агент IA-Connect и записывает текст в файл.

Запуск альтернативного агента IA-Connect

Запускает альтернативный агент IA-Connect (например, более позднюю версию), загрузив исполняемый файл агента из расположения файла.

Запуск альтернативного агента IA-Connect, отправляемого от директора

Запускает альтернативный агент IA-Connect (например, более позднюю версию), отправив альтернативный агент из директора IA-Connect, а затем загрузите альтернативный исполняемый файл агента.

Запуск процесса PowerShell

Запустите процесс PowerShell, выполняя существующий скрипт на диске или предоставляя содержимое скрипта для выполнения. Вместо этого рекомендуется использовать действие "Запуск скрипта PowerShell", которое гораздо эффективнее и предоставляет таблицу данных выходных данных из скрипта PowerShell. Используйте это действие, если скрипт PowerShell выводит стандартные выходные данные или стандартную ошибку (например, использует Write-Host вместо возврата таблицы), требует PowerShell 7 или выполняет действия Active Directory в качестве альтернативного пользователя, а CredSSP через WinRM недоступен.

Запуск сеанса удаленного рабочего стола (RDS)

Запустите сеанс удаленного рабочего стола (RDS) с помощью файла запуска RDP.

Идентификатор процесса kill

Убивает выполняющийся процесс в сеансе пользователя агента IA-Connect с указанным идентификатором процесса. Идентификаторы процессов уникальны, поэтому только один процесс может соответствовать идентификатору. Идентификаторы процесса являются динамическими и отличаются для каждого запуска приложения.

Изменение состояния задачи автоматизации Orchestrator

Изменяет состояние выбранной задачи автоматизации Orchestrator или другие свойства задачи.

Калибровка mouse_event

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

Каталог очистки

Очищает каталог (папку) на компьютере, где выполняется агент IA-Connect, удаляя все файлы, хранящиеся в каталоге.

Копирование файла

Копирует файл на компьютере, на котором запущен агент IA-Connect.

Копирование файла в буфер обмена

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

Копирование файла с клиента на сервер

Копирует файл с локального компьютера (под управлением директора IA-Connect) на удаленный компьютер (запуск агента IA-Connect).

Левая кнопка мыши вверх

Освобождает левую кнопку мыши в сеансе пользователя агента IA-Connect.

Левая кнопка мыши вниз

Нажимает (и не освобождает) левую кнопку мыши в сеансе пользователя агента IA-Connect. Чтобы освободить мышь, используйте действие мыши слева.

Левая удерживаемая мышь

Удерживает левую кнопку мыши в сеансе пользователя агента IA-Connect в течение указанного количества секунд.

Левая удерживаемая мышь в координате

Удерживает левую кнопку мыши по указанным координатам в сеансе пользователя агента IA-Connect в течение указанного количества секунд. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Назначение задачи автоматизации Orchestrator

Назначает выбранную задачу автоматизации Orchestrator указанному пользователю или группе. Это назначение будет передано исходной системе, связанной с этой задачей автоматизации (например, ServiceNow), и чаще всего используется для передачи билета другому лицу или группе людей для дополнительной обработки. Если задача автоматизации Orchestrator не связана с источником, создается исключение.

Настройка буфера обмена

Задает содержимое буфера обмена в сеансе пользователя агента IA-Connect.

Настройка выходных данных задачи автоматизации Orchestrator

Задает выходные данные для задачи автоматизации Orchestrator. Обычно используется при выполнении задачи и требуется предоставить выходные данные, собираемые процессом, создавшего задачу.

Настройка глобальной конфигурации координат агента IA-Connect

Настраивает глобальную систему координат агента IA-Connect, которая используется для отображения расположений элементов (например, во время проверки мыши) и вычисления позиций мыши (например, при выполнении глобальных действий мыши). Значения по умолчанию предоставляют последние функциональные возможности, но вы можете использовать это действие, чтобы вернуться к поведению в предыдущих версиях агента или указать, что API использует другую систему координат.

Настройка директора IA-Connect следующего прыжка

Настройте директор следующего прыжка в сценарии двойного прыжка. Это необходимо только в том случае, если параметры директора следующего прыжка по умолчанию IA-Connect не подходят.

Настройка ключа лицензии IA-Connect

Лицензирует агент IA-Connect с помощью ключа лицензии. Это может быть строка лицензии или понятное имя лицензии, удерживаемой в IA-Connect Orchestrator.

Настройка кода лицензии IA-Connect

Отправляет лицензию на домен агента старого стиля (7.0 и 7.1) в агент IA-Connect.

Настройка непрозрачности графического интерфейса агента IA-Connect

Задает прозрачность агента IA-Connect от 1 (видимо) до 0 (прозрачно).

Настройка режима обслуживания рабочей роли Orchestrator

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

Настройка средства чтения с экрана

Включает или отключает средство чтения с экрана в сеансе пользователя агента IA-Connect.

Настройка уровня журнала IA-Connect директора

Задает уровень ведения журнала IA-Connect директора указанным значением. Уровни ведения журнала задаются от 0 до 4. Значение 0 отключено. 1 — самый низкий уровень журнала (и по умолчанию). 4 — самый высокий уровень журнала.

Обновление результата статистики потока Orchestrator

Обновите статистику результатов для текущего рабочего потока в IA-Connect Orchestrator. Это используется для изменения окончательного результата статистики потока в IA-Connect Orchestrator, который обычно используется для создания отчетов. Это работает только для текущего потока (Оркестратор обнаруживает идентификатор выполнения потока). Невозможно изменить статистику для любого другого потока.

Остановка активности сеанса

Останавливает сеанс пользователя агента IA-Connect.

Отвечает ли TCP-порт

Сообщает, отвечает ли сетевой TCP-порт на попытку подключения агентом IA-Connect. Это может быть TCP-порт на компьютере, на котором запущен агент IA-Connect (введите localhost для удаленного узла) или на любом удаленном компьютере. Если агент IA-Connect успешно подключается к TCP-порту, он немедленно закрывает TCP-подключение.

Отключение IA-Connect следующего прыжка

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

Отключение удаленного сеанса

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

Отложить существующую задачу автоматизации Orchestrator

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

Отложить существующую операцию автоматизации Orchestrator

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

Отправка ключевых событий

Отправляет события глобального нажатия клавиши в сеанс пользователя агента IA-Connect с помощью драйвера клавиатуры низкого уровня. Это имитирует пользователя, нажимая эти клавиши на клавиатуре. Убедитесь, что целевой элемент Window сосредоточен, или нажатия клавиш могут быть получены неправильным приложением или игнорироваться.

Отправка ключей

Отправляет глобальные клавиши в сеанс пользователя агента IA-Connect. Это имитирует пользователя, нажимая эти клавиши на клавиатуре. Убедитесь, что целевой элемент Window сосредоточен, или нажатия клавиш могут быть получены неправильным приложением или игнорироваться.

Отправка ключей паролей

Отправляет глобальные клавиши в сеанс пользователя агента IA-Connect специально для ввода пароля. Это имитирует пользователя, нажимая эти клавиши на клавиатуре. Убедитесь, что целевой элемент Window сосредоточен, или нажатия клавиш могут быть получены неправильным приложением или игнорироваться.

Отправка событий ключа пароля

Отправляет события глобального нажатия клавиши в сеанс пользователя агента IA-Connect, специально для ввода пароля с помощью драйвера клавиатуры низкого уровня. Это имитирует пользователя, нажимая эти клавиши на клавиатуре. Убедитесь, что целевой элемент Window сосредоточен, или нажатия клавиш могут быть получены неправильным приложением или игнорироваться.

Отправка сообщения в веб-API

Отправьте сообщение в веб-API и получите ответ. Это можно использовать с любым веб-API, но обычное использование будет REST API. IA-Connect поддерживает отправку сообщений веб-API из виртуальной машины (например, для доступа к локальным ресурсам) или сеансов Citrix или Microsoft Remote Desktop (например, для доступа к API только из изолированных сред).

Очистка буфера обмена

Очищает содержимое буфера обмена в сеансе пользователя агента IA-Connect.

Переместить файл

Перемещает файл на компьютере, на котором запущен агент IA-Connect.

Перемещение мыши в координату

Перемещает мышь в сеансе пользователя агента IA-Connect на указанные координаты пикселей. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Перемещение мыши между координатами

Перемещает мышь между двумя указанными координатами в сеансе пользователя агента IA-Connect. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат. Необязательный jitter поддерживается в движении мыши, чтобы сделать его более похожим на движение человеческой руки.

Перемещение относительного указателя мыши

Перемещает мышь в сеансе пользователя агента IA-Connect по указанному количеству пикселей относительно текущей позиции. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Перенос графического интерфейса агента IA-Connect на передний план

Выводит графический интерфейс агента IA-Connect на передний план, чтобы он был видимым на экране.

Перетаскивание мыши влево между координатами

Выполняет перетаскивание левой кнопки мыши между двумя указанными координатами в сеансе пользователя агента IA-Connect. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат. Необязательный jitter поддерживается в движении мыши, чтобы сделать его более похожим на движение человеческой руки.

Перетаскивание мыши вправо между координатами

Выполняет перетаскивание правой кнопки мыши между двумя указанными координатами в сеансе пользователя агента IA-Connect. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат. Необязательный jitter поддерживается в движении мыши, чтобы сделать его более похожим на движение человеческой руки.

Перетаскивание средней мыши между координатами

Выполняет перетаскивание средней кнопки мыши между двумя указанными координатами в сеансе пользователя агента IA-Connect. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат. Необязательный jitter поддерживается в движении мыши, чтобы сделать его более похожим на движение человеческой руки.

Поворот колесика мыши

Включает колесико мыши (положительные или отрицательные ночи) в сеансе пользователя агента IA-Connect.

Подключение к сеансу уровня 1 IA-Connect

Присоединяется к IA-Connect сессии директора, получающего сообщения SOAP и /или REST. Это сеанс, в который отправляются команды агенту IA-Connect.

Получение буфера обмена

Возвращает текущее содержимое буфера обмена в сеансе пользователя агента IA-Connect.

Получение времени простоя IA-Connect директора

Возвращает время работы этого IA-Connect директора в секундах (т. е. продолжительность работы директора).

Получение всех задач автоматизации Orchestrator

Извлекает все задачи автоматизации Orchestrator, соответствующие фильтрам.

Получение глобальной конфигурации координат агента IA-Connect

Извлекает конфигурацию глобальной системы координат агента IA-Connect, которая используется для отображения расположений элементов (например, во время проверки мыши) и вычисления позиций мыши (например, при выполнении глобальных действий мыши).

Получение домена компьютера

Возвращает домен компьютера, на котором выполняется сеанс пользователя агента IA-Connect.

Получение доступных сеансов IA-Connect

Извлекает список сеансов директора IA-Connect (доступные подключения к сеансам, где выполняется агент IA-Connect, например локальный, Microsoft RDP или Citrix ICA).

Получение журнала агента IA-Connect

Возвращает текущий журнал агента IA-Connect в виде файла или считывая содержимое и возвращая его в выходной переменной.

Получение журнала входа из Orchestrator

Возвращает журнал входа в IA-Connect Orchestrator для создания отчетов. При необходимости можно использовать один или несколько фильтров, чтобы ограничить возвращаемые результаты.

Получение задачи автоматизации Orchestrator

Извлекает определенную задачу автоматизации Orchestrator.

Получение имени компьютера

Возвращает имя компьютера, на котором выполняется сеанс пользователя агента IA-Connect.

Получение имени узла клиента

Возвращает имя узла клиента, на котором выполняется директор IA-Connect.

Получение количества процессов агента IA-Connect

Возвращает количество экземпляров агента IA-Connect, работающего в настоящее время в сеансе пользователя. Это полезно для обнаружения наличия нескольких экземпляров запущенного агента IA-Connect.

Получение количества процессов по имени

Возвращает количество выполняемых процессов в сеансе пользователя агента IA-Connect с указанным именем процесса.

Получение метода перемещения мыши

Возвращает текущий метод перемещения мыши.

Получение операции автоматизации Orchestrator

Извлекает определенную задачу автоматизации Orchestrator, указав уникальный идентификатор операции задачи.

Получение папок

Возвращает все вложенные папки в указанной папке на компьютере, где запущен агент IA-Connect.

Получение последнего неудачного действия из статистики потока Orchestrator

Извлекает сведения о последнем действии, передавшемуся через IA-Connect Orchestrator рабочей роли, если это действие завершилось сбоем. Это действие чаще всего используется во время обработки ошибок.

Получение последних входных данных

Возвращает время после получения последнего ввода пользователем в сеансе пользователя агента IA-Connect.

Получение потоков агента

Возвращает список потоков агента. Поток агента можно использовать для выполнения определенных действий в потоке, что позволяет выполнять действия в течение длительного времени (дольше времени ожидания RPA) или выполняться параллельно с другими действиями. Как правило, после завершения работы потока агента и получения его данных поток агента удаляется и не будет отображаться в списке потоков.

Получение принтера по умолчанию

Возвращает имя принтера по умолчанию для пользователя в сеансе агента IA-Connect.

Получение процесса по идентификатору процесса

Возвращает, выполняется ли процесс с указанным идентификатором процесса в сеансе пользователя агента IA-Connect. Идентификаторы процессов уникальны, поэтому только один процесс может соответствовать идентификатору. Идентификаторы процесса являются динамическими и отличаются для каждого запуска приложения.

Получение процессов

Возвращает список выполняемых процессов в сеансе пользователя агента IA-Connect. При необходимости это можно отфильтровать, указав имя процесса.

Получение рабочей роли Orchestrator

Получение сведений и динамического состояния отдельной рабочей роли, зарегистрированной в IA-Connect Orchestrator.

Получение размера файла

Возвращает размер файла (в байтах) на компьютере, где выполняется агент IA-Connect.

Получение разрешений безопасности папок

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

Получение разрешений на безопасность файлов

Возвращает список разрешений, установленных в данный момент на файле на компьютере, где запущен агент IA-Connect.

Получение разрешения экрана

Возвращает разрешение экрана сеанса пользователя агента IA-Connect. Для IA-Connect локального агента, работающего на физическом рабочем столе или ноутбуке, вы получите сведения обо всех устройствах отображения и их масштабировании. На виртуальной машине обычно сообщается только один дисплей, если виртуальная машина не настроена для представления нескольких дисплеев (редко). В удаленном сеансе обычно сообщается только один дисплей, даже если отображение охватывает несколько локальных дисплеев, так как удаленные сеансы обычно создают один виртуальный дисплей.

Получение родительского идентификатора процесса

Возвращает идентификатор процесса родительского процесса для любого выполняемого процесса в сеансе пользователя агента IA-Connect с указанным идентификатором процесса.

Получение сведений о директоре IA-Connect

Возвращает свойства IA-Connect директора, включая номер версии и путь к исполняемому файлу директора.

Получение сведений о сеансе агента IA-Connect

Возвращает сведения о сеансе пользователя агента IA-Connect.

Получение сведений о среде

Возвращает сведения о среде, в которой выполняется сеанс пользователя агента IA-Connect.

Получение сведений о типе клиента и сеансе директора

Возвращает сведения о локальном или удаленном сеансе, обрабатываемом директором уровня 1.

Получение сведений об агенте IA-Connect

Возвращает свойства агента IA-Connect, включая номер версии и путь к исполняемому файлу агента.

Получение свободного места на диске

Возвращает объем свободного места для указанного диска на компьютере, на котором запущен агент IA-Connect.

Получение свойств командной строки идентификатора процесса

Возвращает свойства командной строки для любого выполняемого процесса в сеансе пользователя агента IA-Connect с указанным идентификатором процесса.

Получение следующей задачи автоматизации Orchestrator

Извлекает следующую задачу автоматизации Orchestrator, соответствующую заданным критериям поиска. Можно извлечь только новые и отложенные задачи (которые достигли даты отсрочки). При удержании задачи не будут извлечены.

Получение содержимого файла в виде Base64

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

Получение сообщения об ошибке действия из результата потока JSON

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

Получение состояния Orchestrator

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

Получение состояния доступности рабочей роли Orchestrator

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

Получение состояния потока агента

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

Получение состояния следующего прыжка IA-Connect

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

Получение сохраненного пароля

Извлекает ранее созданный или сохраненный пароль.

Получение списка дисков

Возвращает список дисков на компьютере, на котором запущен агент IA-Connect.

Получение списка принтеров

Возвращает список всех доступных принтеров в сеансе агента IA-Connect.

Получение списка рабочих ролей Orchestrator

Получите список работников, зарегистрированных в IA-Connect Orchestrator, и их состояние жизни.

Получение статистики доступности рабочей роли из Orchestrator

Возвращает статистику доступности рабочей роли из IA-Connect Orchestrator. Используется для создания отчетов. При необходимости можно использовать один или несколько фильтров, чтобы ограничить возвращаемые результаты.

Получение статистики команд IA-Connect

Возвращает всю хранимую статистику, в которой выполняется команда агента IA-Connect в текущем сеансе.

Получение статистики потока из Orchestrator

Возвращает список статистики потока из IA-Connect Orchestrator. Используется для создания отчетов. При необходимости можно использовать один или несколько фильтров, чтобы ограничить возвращаемые результаты.

Получение текста CSV в виде коллекции

Возвращает CSV-файл на компьютере, где агент IA-Connect работает в качестве коллекции (таблицы). Требуется только доступ только для чтения к CSV-файлу.

Получение текущего состояния лицензии агента IA-Connect

Возвращает, является ли агент IA-Connect лицензирован и лицензирован, а если лицензирован, свойства лицензии.

Получение текущей координаты мыши

Возвращает текущую позицию курсора мыши в сеансе пользователя агента IA-Connect с помощью API setcursorpos.

Получение тепловой карты использования рабочего потока из Orchestrator

Возвращает ежедневное использование тепловой карты рабочего потока из IA-Connect Orchestrator. Используется для создания отчетов. При необходимости можно использовать один или несколько фильтров, чтобы ограничить возвращаемые результаты.

Получение умножения мыши

Извлекает глобальный умножитель мыши в сеансе пользователя агента IA-Connect. Это значение по умолчанию имеет значение (1, 1), но может быть изменено действием "Задать умножение мыши".

Получение универсальных учетных данных из Orchestrator

Извлекает универсальные учетные данные, хранящиеся в IA-Connect Orchestrator. Учетные данные могут содержать имена пользователей, пароли, имена узлов, URL-адреса и другие универсальные данные.

Получение уровня журнала агента IA-Connect

Возвращает текущий уровень ведения журнала агента IA-Connect. Уровни ведения журнала задаются от 1 до 4, при этом 1 — самый низкий уровень и 4 — самый высокий.

Получение уровня журнала директора IA-Connect

Возвращает текущий уровень ведения журнала IA-Connect директора. Уровни ведения журнала задаются от 0 до 4. Значение 0 отключено. 1 — самый низкий уровень журнала (и по умолчанию). 4 — самый высокий уровень журнала.

Получение файлов

Возвращает список файлов в папке (соответствующий csv-списку шаблонов) на компьютере, на котором запущен агент IA-Connect.

Получение цвета пикселей в координате

Возвращает цвет RGB пикселя в заданной координате.

Пометить поток как завершенный

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

Посередине щелчка мыши

Нажмите кнопку средней мыши в сеансе пользователя агента IA-Connect.

Посередине щелчка мыши по координате

Щелкает среднюю кнопку мыши в сеансе пользователя агента IA-Connect по указанным координатам. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Правая кнопка мыши вверх

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

Правая кнопка мыши вниз

Нажимает (и не освобождает) правую кнопку мыши в сеансе пользователя агента IA-Connect. Чтобы освободить мышь, используйте правое действие мыши вверх.

Преобразование координат прямоугольника

Преобразует координату пикселя прямоугольника из виртуальной в физическую или физическую в виртуальную. Если вы хотите преобразовать точку, просто установите right=Left и Bottom=Top. Физические координаты сопоставляют непосредственно с пикселями на мониторе. Виртуальные координаты масштабируются. Если базовое масштабирование всех устройств отображения равно 100%, физические и виртуальные координаты одинаковы.

Присоединение к последнему сеансу IA-Connect

Присоединяется к сеансу директора IA-Connect, который недавно подключен (необязательно указанного типа). Это сеанс, в который отправляются команды агенту IA-Connect.

Присоединение к сеансу IA-Connect по имени

Присоединяется к указанному сеансу директора IA-Connect по имени. Это сеанс, в который отправляются команды агенту IA-Connect.

Присоединение к сеансу IA-Connect по индексу

Присоединяется к указанному сеансу директора IA-Connect по индексу (например, присоединение к первому сеансу Citrix ICA). Это сеанс, в который отправляются команды агенту IA-Connect.

Процесс выполнения

Запустите процесс, команду или приложение.

Процесс убийства

Убивает любой запущенный процесс в сеансе пользователя агента IA-Connect с указанным именем процесса.

Разблокировка сеанса

Разблокирует сеанс, в котором запущен агент IA-Connect. Для этого требуется, чтобы поставщик учетных данных IA-Connect разблокировки был установлен на компьютере, где размещен сеанс, так как только поставщик учетных данных может разблокировать компьютер.

Разверните строку пароля

Принимает входную строку, содержащую ссылки на IA-Connect сохраненных паролей и возвращает эту строку со ссылками, замененными сохраненными паролями.

Развертывание переменной среды

Расширяет строку, содержащую переменные среды (например, %USERPROFILE% или %TEMP%) в сеансе пользователя агента IA-Connect.

Разрыв наследования папок

Прерывает наследование безопасности на компьютере, на котором запущен агент IA-Connect.

Рисование прямоугольника на экране

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

Сброс параметров следующего прыжка IA-Connect директора

Сбрасывает все настраиваемые параметры IA-Connect директора, которые были установлены, восстанавливая параметры по умолчанию.

Сброс статистики команд IA-Connect

Сбрасывает любую хранимую статистику, в которой команда агента IA-Connect выполнена в текущем сеансе.

Скачивание HTTP-файла

Загружает файл на компьютер, на котором выполняется агент IA-Connect с помощью ПРОТОКОЛА HTTP(S).

Снимок экрана

Снимок экрана: сеанс пользователя агента IA-Connect и возвращает его в виде строки в кодировке Base64.

Создание единовременного секрета Orchestrator

Одноразовый секрет предоставляет объект для хранения секрета, который можно получить один раз с помощью неуправляемого уникального URL-адреса. Обычно это используется для совместного использования секретов с 3-й стороной. Вы можете создать одноразовый секрет с помощью пользовательского интерфейса Orchestrator, REST API или потока.

Создание исключения

Создайте исключение с указанным сообщением, если входное исключение не является пустым. Это полезно для активации сообщения об исключении в потоке (HTTP 400), которое затем будет поймано этапом обработки ошибок, если предыдущее действие имело ошибку. Это исключение не записывается в статистике выполнения потока оркестратора IA-Connect.

Создание пароля

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

Создание файла запуска сеанса удаленного рабочего стола (RDS)

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

Создать каталог

Создает каталог (папку) на компьютере, на котором запущен агент IA-Connect.

Сохранение активности сеанса

Сохраняет сеанс пользователя агента IA-Connect, перемещая мышь в указанный интервал, чтобы предотвратить простой сеанс.

Средняя кнопка мыши вверх

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

Средняя кнопка мыши вниз

Нажимает (и не освобождает) среднюю кнопку мыши в сеансе пользователя агента IA-Connect. Чтобы освободить мышь, используйте действие вверх по средней кнопке мыши.

Средняя удерживаемая мышь

Удерживает посередине кнопку мыши в сеансе пользователя агента IA-Connect в течение указанного количества секунд.

Средняя удерживаемая мышь в координате

Удерживает среднюю кнопку мыши по указанным координатам в сеансе пользователя агента IA-Connect в течение указанного количества секунд. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Существует ли IA-Connect сеанс по имени

Возвращает, существует ли указанный сеанс директора IA-Connect. Это сеанс, в который отправляются команды агенту IA-Connect. Имя будет известно из предыдущего действия "Присоединить".

Существует ли каталог

Сообщает true или false, чтобы определить, существует ли каталог (папка) на компьютере, на котором запущен агент IA-Connect.

Существует ли файл

Сообщает true или false о том, существует ли файл на компьютере, на котором запущен агент IA-Connect.

Убийство всех остальных агентов IA-Connect

Убивает любые другие экземпляры агента IA-Connect, которые в настоящее время выполняются в сеансе пользователя. Это обеспечит выполнение только одного экземпляра агента IA-Connect.

Убийство потока агента

Убивает (завершает, прерывает) поток агента. Поток агента можно использовать для выполнения определенных действий в потоке, что позволяет выполнять действия в течение длительного времени (дольше времени ожидания RPA) или выполняться параллельно с другими действиями. Поток агента не удаляется (используйте действие "Удалить поток агента" для удаления потоков), чтобы разрешить любым процессам или потокам мониторинга потока агента получать ошибку "IA-Connect агент был прерван".

Убийство сеанса IA-Connect по имени

Убивает указанный сеанс директора IA-Connect, если он существует. Это сеанс, в который отправляются команды агенту IA-Connect. Имя будет известно из предыдущего действия "Присоединить".

Удаление задачи автоматизации Orchestrator

Удалите задачу автоматизации Orchestrator, которая была отложена.

Удаление операции автоматизации Orchestrator

Удалите определенную задачу автоматизации Orchestrator, указав уникальный идентификатор операции задачи.

Удаление пароля в памяти агента

Удалите пароль, хранящийся в памяти агента, или удалите все сохраненные пароли агента.

Удаление потока агента

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

Удаление удостоверения из системы безопасности папок

Удаляет удостоверение (например, пользователя, группы или компьютера) из разрешений безопасности на папке на компьютере, где выполняется агент IA-Connect.

Удаление удостоверения из системы безопасности файлов

Удаляет удостоверение (например, пользователя, группы или компьютера) из разрешений безопасности на файле на компьютере, где запущен агент IA-Connect.

Удаление файлов

Удаляет файлы в указанной папке, соответствующей шаблону на компьютере, где выполняется агент IA-Connect.

Удаленный сеанс выхода

Регистрирует удаленный сеанс, в котором запущен агент IA-Connect.

Удалить каталог

Удаляет каталог (папку) на компьютере, на котором запущен агент IA-Connect.

Удалить файл

Удаляет файл на компьютере, на котором запущен агент IA-Connect.

Удаляет учетные данные пользователя

Удаляет учетные данные в профиле пользователя в сеансе агента IA-Connect. Учетные данные можно просмотреть на панели управления Windows.

Удерживайте указатель мыши правой кнопкой мыши

Удерживает правую кнопку мыши в сеансе пользователя агента IA-Connect в течение указанного количества секунд.

Удерживайте указатель мыши правой кнопкой мыши в координате

Удерживает правую кнопку мыши по указанным координатам в сеансе пользователя агента IA-Connect в течение указанного количества секунд. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Установка владельца в папке

Задает владельца папки на компьютере, на котором запущен агент IA-Connect.

Установка владельца в файле

Задает владельца файла на компьютере, на котором запущен агент IA-Connect.

Установка времени ожидания команды агента IA-Connect

Задает время ожидания команды, которое будет использоваться агентом IA-Connect для каждой выполняемой команды.

Установка метода перемещения мыши

Задает текущий метод перемещения мыши на mouse_event или setcursorpos.

Установка положения курсора мыши

Задает курсор мыши в сеансе пользователя агента IA-Connect указанной позиции. API setcursorpos используется для перемещения мыши независимо от выбранного API активного перемещения мыши.

Установка принтера по умолчанию

Задает принтер по умолчанию для пользователя в сеансе агента IA-Connect.

Установка самого верхнего графического интерфейса агента IA-Connect

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

Установка умножения мыши

Задает глобальный умножитель мыши в сеансе пользователя агента IA-Connect. Это может быть полезно во время разработки, если возникают проблемы с масштабированием удаленного рабочего стола.

Хранение пароля в памяти агента

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

Чтение всего текста из файла

Считывает текстовое содержимое файла на компьютере, где выполняется агент IA-Connect.

Чтение с учетных данных пользователя

Считывает имя пользователя и пароль из учетных данных в профиле пользователя в сеансе агента IA-Connect. Учетные данные можно просмотреть на панели управления Windows. Имя пользователя и пароль можно получить из универсальных учетных данных, а только имя пользователя можно получить из учетных данных Windows.

Щелкните левую кнопку мыши

Нажмите левую кнопку мыши в сеансе пользователя агента IA-Connect.

Щелкните левую кнопку мыши в координате

Нажмите левую кнопку мыши в сеансе пользователя агента IA-Connect по указанным координатам. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Щелкните правой кнопкой мыши

Щелкните правую кнопку мыши в сеансе пользователя агента IA-Connect.

Щелкните правой кнопкой мыши по координате

Щелкните правую кнопку мыши в сеансе пользователя агента IA-Connect по указанным координатам. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

UnZIP-файл

Распакует файл, сжатый с помощью сжатия ZIP.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к ZIP-файлу
ZIPFilename True string

Полный путь к ZIP-файлу, который необходимо распаковать. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Извлечение папки
ExtractFolder string

Путь к папке для извлечения ZIP-файла. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Извлечение всех файлов в одну папку
ExtractAllFilesToSingleFolder boolean

Если задано значение True, структура папок внутри ZIP-файла будет игнорироваться, и все файлы будут извлечены в указанную папку.

Включение регулярных выражений файлов
IncludeFilesRegEx string

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

Исключить регулярное выражение файлов
ExcludeFilesRegEx string

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Количество извлеченных файлов успешно
FilesExtractedSuccessfully integer

Количество файлов, извлеченных из ZIP-файла успешно.

Количество файлов, которые не удалось извлечь
FilesFailedToExtract integer

Количество файлов, которые не удалось извлечь из ZIP-файла.

Количество исключенных файлов
FilesExcluded integer

Количество исключенных файлов (при использовании входных данных "Исключить регулярные выражения файлов").

Wiggle mouse

Перемещает мышь назад и вперед по указанному числу координат. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши.

Параметры

Имя Ключ Обязательно Тип Описание
X wiggle
XWiggle integer

Количество пикселей для перемещения мыши по горизонтали.

Y wiggle
YWiggle integer

Количество пикселей для перемещения мыши по вертикали.

Задержка wiggle в секундах
WiggleDelayInSeconds double

Количество секунд между движениями мыши.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Блокировка сеанса

Блокирует сеанс, в котором выполняется агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Блокировка после нескольких минут бездействия
LockAfterMinutesOfActionInactivity integer

Если задано значение больше 0, агент не заблокирует немедленно, но будет блокироваться после указанного количества минут бездействия (агент не получает никаких действий). Это останавливает агент от постоянной блокировки и разблокировки, когда существует множество потоков, выполняющихся обратно в спину. Установите значение 0 для немедленной блокировки. Значение по умолчанию — 5 минут.

Секунды ожидания после блокировки
SecondsToWaitAfterLock integer

После блокировки дождитесь указанного количества секунд. Это дает сеансу время полной блокировки. Обычно это используется, если вы ожидаете возможность события разблокировки (т. е. другого сеанса запуска) сразу после блокировки, что может завершиться ошибкой, если предыдущий сеанс по-прежнему блокируется. Используется только в том случае, если значение "Блокировка после минут бездействия" имеет значение 0 (вызывая немедленную блокировку).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
LockSessionResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Включение IA-Connect следующего прыжка

Включает следующий прыжок, который перенаправит все будущие команды, полученные на агент IA-Connect, запущенный в следующем сеансе прыжка.

Параметры

Имя Ключ Обязательно Тип Описание
Адрес директора следующего прыжка
NextHopDirectorAddress string

Необязательный адрес для следующего прыжка IA-Connect директор для пересылки команд, если ни один из параметров "Директор следующего прыжка localhost", "Адрес директора следующего прыжка имеет имя узла", "Адрес директора следующего прыжка — полное доменное имя" или "Адрес директора следующего прыжка называется каналом", задано значение true.

Tcp-порт директора следующего прыжка
NextHopDirectorTCPPort integer

TCP-порт, который прослушивает директор следующего прыжка (директор на компьютере, на котором работает агент).

Директор следующего прыжка использует HTTPS
NextHopDirectorUsesHTTPS boolean

Установите значение True, если следующий директор прыжка использует HTTPS или false, если нет.

Адрес директора следующего прыжка — localhost
NextHopDirectorAddressIsLocalhostname boolean

Адрес директора следующего прыжка (относительно агента) — localhost.

Адрес директора следующего прыжка — имя узла
NextHopDirectorAddressIsHostname boolean

Адрес директора следующего прыжка — это имя узла компьютера, на котором запущен агент (т. е. тот, который выполняет агент и директор).

Адрес директора следующего прыжка — полное доменное имя
NextHopDirectorAddressIsFQDN boolean

Адрес директора следующего прыжка — это полное доменное имя компьютера, на котором запущен агент (т. е. тот, который работает агентом и директором).

Увеличение следующего прыжка директор TCP-порта по идентификатору сеанса
IncrementNextHopDirectorTCPPortBySessionId boolean

Чтобы гарантировать, что tcp-порт директора следующего прыжка является уникальным (если существует несколько параллельных сеансов с помощью следующего прыжка с одного узла), идентификатор сеанса можно добавить в TCP-порт директора следующего прыжка.

Отключить перед включением
DisableBeforeEnable boolean

Следует ли отключить двойной прыжок (если сейчас активен) перед включением еще раз? Если задано значение true (по умолчанию), все новые инструкции по включению двойного прыжка заменят предыдущие. Если задано значение false, это позволит включить тройной прыжк, так как инструкции будут получены агентом двойного прыжка IA-Connect.

Проверка запуска директора следующего прыжка
CheckNextHopDirectorIsRunning boolean

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

Проверка запуска агента следующего прыжка
CheckNextHopAgentIsRunning boolean

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

Адрес директора следующего прыжка называется каналом
NextHopDirectorAddressIsNamedPipe boolean

Адрес директора следующего прыжка (относительно агента) использует именованный канал вместо веб-службы TCP/IP. Это по умолчанию, чтобы избежать использования портов TCP/IP в первом прыжке.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Адрес директора следующего прыжка
ActiveNextHopDirectorAddress string

Адрес активного директора следующего прыжка, если он используется.

Активный tcp-порт директора следующего прыжка
ActiveNextHopDirectorTCPPort integer

TCP-порт активного директора следующего прыжка, если он используется.

Активный директор следующего прыжка использует HTTPS
ActiveNextHopDirectorUsesHTTPS boolean

Возвращает значение true, если активный директор следующего прыжка использует ПРОТОКОЛ HTTPS.

URL-адрес директора следующего прыжка
ActiveNextHopDirectorURL string

URL-адрес активного директора следующего прыжка.

Включение наследования безопасности папок

Включает наследование безопасности в папке на компьютере, где запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к папке
FolderPath True string

Полный путь к папке. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Включено средство чтения с экрана

Возвращает значение, включено ли средство чтения с экрана в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Включено средство чтения с экрана
ScreenReaderEnabled boolean

Возвращает значение true, если средство чтения с экрана было включено.

Выделение рабочей роли из Orchestrator

Выделяет рабочую роль из IA-Connect Orchestrator. Вы можете запросить рабочую роль по тегу или имени рабочей роли (или ни к тому, ни другому), что позволяет точнее выбрать нужную рабочую роль. После выделения рабочей роли он назначается потоку и будет сообщаться как о выполнении работы. Обратите внимание, что Оркестратор по-прежнему будет рассматривать "Поддерживаемые идентификаторы среды потока", "Поддерживаемые имена потоков" и "Неподдерживаемые имена потоков" при выполнении выделения. Если несколько рабочих ролей соответствуют поиску, будут применяться обычные правила балансировки нагрузки.

Параметры

Имя Ключ Обязательно Тип Описание
Тег рабочей роли
WorkerTag string

Необязательный тег рабочей роли для выделения. Теги позволяют классифицировать работников в группы. Имена тегов не учитывает регистр. Вы можете указать несколько тегов, введя их в отдельных строках, а затем механизм выделения будет рассматривать любую рабочую роль с любым из этих тегов (только один тег должен соответствовать). Вы можете выполнить поиск подстановочных знаков с помощью подстановочного знака формата: Tag* (например, подстановочный знак: JML*) и поиска регулярных выражений с помощью формата RegEx: TagExpression (например, RegEx: ^JML).

Имя работника
WorkerName string

Необязательное имя рабочей роли для выделения. Имена рабочих ролей не учитывает регистр. Вы можете указать несколько рабочих ролей, введя их в отдельные строки, а затем механизм распределения будет рассматривать любую рабочую роль с соответствующим именем. Вы можете выполнить поиск подстановочных знаков с помощью подстановочного знака формата: Name* (например, подстановочный знак: vmrpa*) и поиска регулярных выражений с помощью формата RegEx: Expression (например, RegEx: ^vmrpa).

Вызов исключения, если рабочая роль не сразу доступна
RaiseExceptionIfWorkerNotImmediatelyAvailable boolean

Если задано значение true и не удалось выделить подходящую рабочую роль, создается исключение. Если задано значение false (значение по умолчанию) и не удалось выделить подходящую рабочую роль, оркестратор вернет код состояния HTTP 500, что приведет к ожиданию потока PA в соответствии с политикой повторных попыток.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Выделенное имя рабочей роли
WorkerNameAllocated string

Имя выделенной рабочей роли. Пустое значение, если рабочий объект не был выделен.

Выполнение команды универсального агента IA-Connect

Выполняет универсальную команду агента IA-Connect, передавая аргументы в формате JSON и возвращая выходные данные в формате JSON. Используется для выполнения команд агента, когда директор и инспектор являются более старыми версиями, чем агент, и поэтому не понимает команду.

Параметры

Имя Ключ Обязательно Тип Описание
имя команды агента IA-Connect
CommandName True string

Внутреннее имя команды агента IA-Connect. Список имен команд можно указать действием GetAgentActionsInClass.

Входной код JSON
InputJSON string

Входные данные команды агента IA-Connect в формате JSON.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Выходные данные JSON
OutputJSON string

Выходные данные команды агента IA-Connect в формате JSON.

Дважды слева щелкните мышь в координате

Дважды нажимает левую кнопку мыши в сеансе пользователя агента IA-Connect по указанным координатам. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Параметры

Имя Ключ Обязательно Тип Описание
X пикселей
XCoord True integer

Значение координат X (в пикселях).

Y пикселей
YCoord True integer

Значение координаты Y (в пикселях).

Задержка в миллисекундах
DelayInMilliseconds integer

Задержка между каждым щелчком в миллисекундах.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Дважды щелкните левую кнопку мыши

Дважды щелкает левую кнопку мыши в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Задержка в миллисекундах
DelayInMilliseconds integer

Задержка между каждым щелчком в миллисекундах.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Добавление заметки в задачу автоматизации Orchestrator

Добавляет заметку к выбранной задаче автоматизации Orchestrator. Эта заметка будет передана исходной системе, связанной с этой задачей автоматизации (например, ServiceNow), и чаще всего используется для добавления сведений в билет. Если задача автоматизации Orchestrator не связана с источником, создается исключение.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор задачи
TaskId True integer

Идентификатор задачи Orchestrator для добавления заметки.

Текст заметки
NoteText True string

Текстовое сообщение заметки.

Тип заметки
NoteType string

Если исходная система поддерживает различные типы заметок (например, рабочую заметку, заметку о закрытии или комментарий), введите здесь тип заметки. Это будет интерпретироваться по-разному в зависимости от исходной системы. В настоящее время поддерживаются типы WorkNote (по умолчанию), CloseNote, Comment. Если существует только один тип заметки, введите WorkNote. Если у вас есть настраиваемая рабочая заметка, введите "Другое".

Другие типы заметок
NoteTypeOther string

Если у вас есть пользовательский тип заметок, выберите "Тип заметки" "Другие" и введите настраиваемый тип в это поле.

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
TasksAddNoteResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Добавление новой задачи автоматизации Orchestrator

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

Параметры

Имя Ключ Обязательно Тип Описание
Задание имени службы автоматизации
SetAutomationName string

Выберите "Авто", если вы хотите использовать имя потока в качестве имени задачи или выберите "Вручную" и введите имя в поле "Имя службы автоматизации", чтобы использовать это имя.

Имя службы автоматизации
AutomationName string

Это будет использоваться только в том случае, если параметр "Вручную" выбран в поле "Задать имя службы автоматизации". Понятное имя, заданное для определения задачи позже или связывания ее с определенным потоком. Несколько задач могут использовать одно и то же имя автоматизации. Имя конкретной задачи требуется, если задача обрабатывается внешним опрашителем или триггером Orchestrator.

Входные данные задачи
TaskInputData string

Необязательные данные для доступности задачи при запуске. Вы можете хранить данные в любом формате, но JSON — это часто используемый формат.

Этап процесса
ProcessStage string

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

Priority
Priority integer

Задайте уровень приоритета этой задачи автоматизации (1 — самый высокий уровень).

Соглашение об уровне обслуживания в минутах
SLA integer

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

Размещение задачи на удержание
TaskOnHold boolean

Укажите состояние задачи "В удержании". Набор задач "В удержании" не будет получен действием "Получение следующей задачи автоматизации Orchestrator", поэтому не будет обрабатываться в типичном рабочем процессе задачи.

Организация
Organisation string

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

Отдел
Department string

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

Description
Description string

При необходимости укажите описание этой задачи. Обычно используется для поиска и фильтрации задач.

Метки
Tags string

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор задачи
TaskId integer

Идентификатор созданной задачи автоматизации Orchestrator. Этот идентификатор задачи можно использовать для получения задачи на более позднюю дату.

Добавление новой операции автоматизации Orchestrator

Добавьте новую задачу автоматизации Orchestrator и получите идентификатор операции. Имя конкретной задачи требуется, если задача обрабатывается внешним опрашителем или триггером Orchestrator. Это действие отличается от задачи "Добавление новой задачи автоматизации Orchestrator" (TasksAddNewTaskOperation), в том случае, что она отвечает с идентификатором неугадываемой операции, а не идентификатором угадываемой задачи.

Параметры

Имя Ключ Обязательно Тип Описание
Имя службы автоматизации
AutomationName string

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

Входные данные задачи
TaskInputData string

Необязательные данные для доступности задачи при запуске. Вы можете хранить данные в любом формате, но JSON — это часто используемый формат.

Этап процесса
ProcessStage string

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

Priority
Priority integer

Задайте уровень приоритета этой задачи автоматизации (1 — самый высокий уровень).

Соглашение об уровне обслуживания в минутах
SLA integer

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

Организация
Organisation string

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

Отдел
Department string

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

Description
Description string

При необходимости укажите описание этой задачи. Обычно используется для поиска и фильтрации задач.

Метки
Tags string

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

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор операции
OperationId string

Идентификатор операции созданной задачи автоматизации Orchestrator. Этот идентификатор операции можно использовать для получения задачи на более позднюю дату. Идентификатор операции является уникальной, неуправляемой строкой, ограничивающей возможность для 3-й стороны угадать идентификатор операции, которая они не создали.

Добавление новой отложенной задачи Orchestrator

Добавьте новую отложенную задачу Orchestrator в очередь, которую можно отслеживать из потока. Задача будет отложена до указанного времени в будущем. Используйте это действие для временной приостановки задачи на определенный период времени (например, если вы ожидаете что-то).

Параметры

Имя Ключ Обязательно Тип Описание
Задание имени службы автоматизации
SetAutomationName string

Выберите "Авто", если вы хотите использовать имя потока в качестве имени задачи или выберите "Вручную" и введите имя в поле "Имя службы автоматизации", чтобы использовать это имя.

Имя службы автоматизации
AutomationName string

Это будет использоваться только в том случае, если параметр "Вручную" выбран в поле "Задать имя службы автоматизации". Понятное имя, заданное для определения задачи позже или связывания ее с определенным потоком. Несколько задач могут использовать одно и то же имя автоматизации.

Время отсрочки в минутах
DeferralTimeInMinutes integer

Сколько минут должно быть отложено задаче автоматизации.

Входные данные задачи
TaskInputData string

Необязательные данные для доступности задачи при запуске. Вы можете хранить данные в любом формате, но JSON — это часто используемый формат.

Отсрочка хранимых данных
DeferralStoredData string

Необязательные данные для хранения с этой задачей. Он станет доступным для процесса или потока, когда он продолжается с отсрочки. Обычно это используется для хранения данных, вычисляемых во время процесса или потока, которые необходимо снова получить после отсрочки. Вы можете хранить данные в любом формате, но JSON — это часто используемый формат.

Этап процесса
ProcessStage string

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

Priority
Priority integer

Задайте уровень приоритета этой задачи (1 — самый высокий уровень).

Размещение задачи на удержание
TaskOnHold boolean

Укажите состояние задачи "В удержании". Набор задач "В удержании" не будет получен действием "Получение следующей задачи автоматизации Orchestrator", поэтому не будет обрабатываться в типичном рабочем процессе задачи.

Организация
Organisation string

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

Отдел
Department string

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

Description
Description string

При необходимости укажите описание этой задачи. Обычно используется для поиска и фильтрации задач.

Метки
Tags string

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор задачи
TaskId integer

Идентификатор созданной задачи отсрочки.

Добавление новой отложенной операции задачи Orchestrator

Добавьте новую отложенную задачу Orchestrator и получите идентификатор операции. Задача будет отложена до указанного времени в будущем. Используйте это действие для временной приостановки задачи на определенный период времени (например, если вы ожидаете что-то). Имя конкретной задачи требуется, если задача обрабатывается внешним опрашителем или триггером Orchestrator. Это действие отличается от "Добавление новой отложенной задачи Orchestrator" (TasksAddNewDeferral), в том случае, что оно отвечает с помощью неугадываемого идентификатора операции, а не идентификатора угадываемой задачи.

Параметры

Имя Ключ Обязательно Тип Описание
Имя службы автоматизации
AutomationName string

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

Время отсрочки в минутах
DeferralTimeInMinutes integer

Сколько минут должно быть отложено задаче автоматизации.

Входные данные задачи
TaskInputData string

Необязательные данные для доступности задачи при запуске. Вы можете хранить данные в любом формате, но JSON — это часто используемый формат.

Отсрочка хранимых данных
DeferralStoredData string

Необязательные данные для хранения с этой задачей. Он станет доступным для процесса или потока, когда он продолжается с отсрочки. Обычно это используется для хранения данных, вычисляемых во время процесса или потока, которые необходимо снова получить после отсрочки. Вы можете хранить данные в любом формате, но JSON — это часто используемый формат.

Этап процесса
ProcessStage string

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

Priority
Priority integer

Задайте уровень приоритета этой задачи автоматизации (1 — самый высокий уровень).

Организация
Organisation string

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

Отдел
Department string

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

Description
Description string

При необходимости укажите описание этой задачи. Обычно используется для поиска и фильтрации задач.

Метки
Tags string

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

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор операции
OperationId string

Идентификатор операции отложенной задачи Orchestrator. Этот идентификатор операции можно использовать для получения задачи на более позднюю дату. Идентификатор операции является уникальной, неуправляемой строкой, ограничивающей возможность для 3-й стороны угадать идентификатор операции, которая они не создали.

Добавление папки в ZIP

ZIPs-файлы в папке в ZIP-файл (сохраняет файлы в архив сжатия).

Параметры

Имя Ключ Обязательно Тип Описание
Исходная папка для добавления в ZIP-файл
SourceFolderToAddToZIP True string

Путь к папке, добавляемой в ZIP-файл. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Путь к ZIP-файлу вывода
OutputZIPFilename True string

Путь к файлу, в который должен выводиться ZIP-файл. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Добавление файлов в папку в ZIP
AddFilesToFolderInZIP string

Если вы хотите добавить исходные файлы в папку в ZIP-файле, введите здесь имя папки.

Сжимать
Compress boolean

Следует ли сжимать папку при zipping?

Добавление в существующий ZIP-файл
AddToExistingZIPFile boolean

Задайте значение True, чтобы добавить в существующий ZIP-файл.

Включить вложенные папки
IncludeSubfolders boolean

Должны ли вложенные папки в исходной папке также добавляться в ZIP-файл?

Включение регулярных выражений файлов
IncludeFilesRegEx string

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

Исключить регулярное выражение файлов
ExcludeFilesRegEx string

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Количество добавленных файлов успешно
FilesAddedSuccessfully integer

Количество файлов, успешно добавленных в ZIP-файл.

Количество исключенных файлов
FilesExcluded integer

Количество исключенных файлов (при использовании входных данных "Исключить регулярные выражения файлов").

Добавление разрешения в папку

Добавляет разрешение на папку на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к папке
FolderPath True string

Полный путь к папке. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Идентичность
Identity True string

Удостоверение (например, пользователь, группа или компьютер), назначаемое разрешением. Это может быть в форме "имя пользователя", "ДОМЕН\имя_пользователя" или "username@domainfqdn".

Разрешение
Permission True string

Предоставьте разрешение на назначение (Read, ReadAndExecute, Modify или FullControl) или оставьте пустым значение по умолчанию (чтение).

Применить к папке
ApplyToFolder boolean

Должно ли разрешение применяться к самой папке?

Применение к вложенным папкам
ApplyToSubFolders boolean

Должно ли разрешение распространяться в вложенные папки?

Применение к файлам
ApplyToFiles boolean

Должно ли разрешение применяться к файлам в папке?

Deny
Deny boolean

Запрещается ли разрешение?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Добавление разрешения на файл

Добавляет разрешение на файл на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу
FilePath True string

Полный путь к файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Идентичность
Identity True string

Удостоверение пользователя или группы, назначаемое разрешением. Это может быть в форме "имя пользователя", "ДОМЕН\имя_пользователя" или "username@domainfqdn".

Разрешение
Permission True string

Предоставьте разрешение на назначение (Read, ReadAndExecute, Modify или FullControl) или оставьте пустым значение по умолчанию (чтение).

Deny
Deny boolean

Запрещается ли разрешение?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Добавление файла в ZIP-файл

ZIPs a file (сохраняет файл в архив сжатия).

Параметры

Имя Ключ Обязательно Тип Описание
Путь к исходному файлу для добавления в ZIP-файл
SourceFilenameToAddToZIP True string

Путь к файлу, который нужно добавить в ZIP-файл. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Путь к ZIP-файлу вывода
OutputZIPFilename True string

Путь к файлу, в который должен выводиться ZIP-файл. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Добавление имени файла в папку в ZIP-файле
AddFilenameToFolderInZIP string

Если вы хотите добавить исходный файл в папку в ZIP-файле, введите здесь имя папки.

Имя исходного файла для добавления в ZIP-комментарий
SourceFilenameToAddToZIPComment string

Необязательный комментарий для этого файла, добавленный в ZIP-файл.

Сжимать
Compress boolean

Следует ли сжимать файл при zipping?

Добавление в существующий ZIP-файл
AddToExistingZIPFile boolean

Задайте значение True, чтобы добавить в существующий ZIP-файл.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Дождитесь закрытия сеанса IA-Connect по имени

Ожидает закрытия указанного сеанса директора IA-Connect. Это сеанс, в который отправляются команды агенту IA-Connect. Имя будет известно из предыдущего действия "Присоединить".

Параметры

Имя Ключ Обязательно Тип Описание
имя сеанса IA-Connect
IAConnectSessionName True string

Имя проверяемого сеанса IA-Connect.

Время ожидания в секундах
TimeToWaitInSeconds integer

Если сеанс указанного типа отсутствует (если указан определенный тип), сколько времени IA-Connect ждать его?

Вызов исключения при истечении времени ожидания
RaiseExceptionIfTimedout boolean

Следует ли IA-Connect вызывать исключение, если новый сеанс не подключен до истечения периода ожидания?

Присоединение к сеансу уровня 1 IA-Connect при успешном выполнении
AttachToTier1IAConnectSessionOnSuccess boolean

Следует ли IA-Connect подключиться к сеансу уровня 1 IA-Connect (сеанс директора IA-Connect, получающего сообщения SOAP и /или REST), если сеанс успешно закрыт?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
закрытый сеанс IA-Connect
IAConnectSessionClosed boolean

Возвращает значение true, если сеанс с указанным именем закрыт или false, если нет.

Имя сеанса подключенного уровня 1 IA-Connect
AttachedTier1IAConnectSessionName string

Имя сеанса уровня 1 IA-Connect, к которому был подключен.

Дождитесь подключения сеанса следующего прыжка IA-Connect

Ожидает подключения к следующему сеансу прыжка и выполнения агента IA-Connect в следующем сеансе прыжка.

Параметры

Имя Ключ Обязательно Тип Описание
Адрес директора следующего прыжка
NextHopDirectorAddress string

Необязательный адрес для следующего прыжка IA-Connect директор для пересылки команд, если ни один из параметров "Директор следующего прыжка localhost", "Адрес директора следующего прыжка имеет имя узла", "Адрес директора следующего прыжка — полное доменное имя" или "Адрес директора следующего прыжка называется каналом", задано значение true.

Tcp-порт директора следующего прыжка
NextHopDirectorTCPPort integer

TCP-порт, который прослушивает директор следующего прыжка (директор на компьютере, на котором работает агент).

Директор следующего прыжка использует HTTPS
NextHopDirectorUsesHTTPS boolean

Установите значение True, если следующий директор прыжка использует HTTPS или false, если нет.

Адрес директора следующего прыжка — localhost
NextHopDirectorAddressIsLocalhostname boolean

Адрес директора следующего прыжка (относительно агента) — localhost.

Адрес директора следующего прыжка — имя узла
NextHopDirectorAddressIsHostname boolean

Адрес директора следующего прыжка — это имя узла компьютера, на котором запущен агент (т. е. тот, который выполняет агент и директор).

Адрес директора следующего прыжка — полное доменное имя
NextHopDirectorAddressIsFQDN boolean

Адрес директора следующего прыжка — это полное доменное имя компьютера, на котором запущен агент (т. е. тот, который работает агентом и директором).

Увеличение следующего прыжка директор TCP-порта по идентификатору сеанса
IncrementNextHopDirectorTCPPortBySessionId boolean

Чтобы гарантировать, что tcp-порт директора следующего прыжка является уникальным (если существует несколько параллельных сеансов с помощью следующего прыжка с одного узла), идентификатор сеанса можно добавить в TCP-порт директора следующего прыжка.

Время ожидания в секундах
SecondsToWait double

Максимальное количество секунд, дожидающегося подключения сеанса следующего прыжка.

Адрес директора следующего прыжка называется каналом
NextHopDirectorAddressIsNamedPipe boolean

Адрес директора следующего прыжка (относительно агента) использует именованный канал вместо веб-службы TCP/IP. Это по умолчанию, чтобы избежать использования портов TCP/IP в первом прыжке.

Отключение существующего следующего прыжка
DisableExistingNextHop boolean

Следует ли отключить двойной прыжок (если сейчас активен) перед включением еще раз? Если задано значение true (по умолчанию), все новые инструкции по включению двойного прыжка заменят предыдущие. Если задано значение false, это позволит включить тройной прыжк, так как инструкции будут получены агентом двойного прыжка IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Сеанс следующего прыжка подключен
NextHopSessionConnected boolean

Возвращает значение true, если сеанс следующего прыжка подключен до превышения максимального времени ожидания.

Дождитесь успешного завершения потока агента

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор потока
ThreadId True integer

Если вы ранее выполнили действие агента в качестве потока, укажите идентификатор потока для получения состояния потока. Этот идентификатор потока будет предоставлен в виде выходных данных предыдущего выполнения действия в качестве потока.

Секунды ожидания потока
SecondsToWaitForThread True integer

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

Получение выходных данных потока
RetrieveThreadOutputData boolean

Задайте значение true, чтобы получить выходные данные потока в формате JSON. Рекомендуется получить выходные данные потока, вызвав то же действие, которое используется для создания потока, установив входные данные "Получение выходных данных для идентификатора потока" в идентификатор потока, но этот параметр позволяет напрямую получить выходные данные потока и при необходимости не удалять данные.

Удаление потока после получения выходных данных
ClearOutputDataFromMemoryOnceRead boolean

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

Вызов исключения, если поток не завершен
RaiseExceptionIfThreadNotCompleted boolean

Если задано значение true, и поток не завершился в указанное время, создается исключение. Если задано значение false, это действие будет ожидать до запрошенного времени (для завершения потока) и сообщить о состоянии потока (см. выходные данные "Поток выполняется" и т. д.). Исключение всегда будет возникать, если поток завершается, но в случае сбоя.

Вызов исключения, если ошибка потока
RaiseExceptionIfThreadError boolean

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

Секунды ожидания для каждого вызова
SecondsToWaitPerCall integer

Значение "Секунды ожидания потока" будет разбито на небольшие срезы времени, чтобы избежать времени ожидания. Этот необязательный вход позволяет указать размер меньшего среза времени. Не устанавливайте значение, превышающее 80% времени ожидания RPA, или вы можете получать ошибки времени ожидания.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Поток начал
ThreadStarted boolean

Значение true, если поток запущен. False, если поток еще не запущен, что предполагает, что что-то пошло не так, так как поток запускается немедленно. Полезно только при вызове исключения, если поток не завершен, имеет значение false, так как в противном случае исключение будет возникать, если поток не завершился в указанное время ожидания.

Поток выполняется
ThreadRunning boolean

Значение true, если поток запущен в данный момент. Значение false, если поток никогда не запущен (крайне маловероятно) или если поток завершен. Полезно только при вызове исключения, если поток не завершен, имеет значение false, так как в противном случае исключение будет возникать, если поток не завершился в указанное время ожидания.

Поток завершен
ThreadCompleted boolean

Значение true, если поток завершен. Значение false, если поток никогда не запущен (крайне маловероятно) или если поток по-прежнему запущен. Полезно только при вызове исключения, если поток не завершен, имеет значение false, так как в противном случае исключение будет возникать, если поток не завершился в указанное время ожидания.

Поток успешно выполнен
ThreadSuccess boolean

Значение true, если поток успешно завершен. Значение false, если поток никогда не запущен (крайне маловероятно), поток по-прежнему выполняется или если поток завершился сбоем. Полезно только при вызове исключения, если поток не завершен, имеет значение false, так как в противном случае исключение будет возникать, если поток не завершился в указанное время ожидания.

Среда выполнения потоков в секундах
ThreadRuntimeInSeconds integer

Общее количество секунд, запущенных потоком.

имя действия IA-Connect
IAConnectActionName string

Внутреннее имя действия агента IA-Connect, выполняемого в качестве потока.

Сообщение о состоянии потока
ThreadStatusMessage string

Текстовая строка, описывающая состояние потока. Это сообщение вычисляется из свойств ThreadStarted,ThreadRunning,ThreadCompleted,ThreadSuccess. Эта текстовая строка является независимой от языка (она не изменится на соответствие языковому стандарту).

Сообщение об ошибке потока
ThreadErrorMessage string

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

Выходные данные потока JSON
ThreadOutputJSON string

Если для параметра "Получение выходных данных потока" задано значение true, этот вывод содержит необработанные выходные данные потока в формате JSON.

Доступно ли каталог

Возвращает значение, доступно ли каталог (папка) и ограничивает ли разрешения доступ к нему на компьютере, где IA-Connect агент.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к каталогу
DirectoryPath True string

Полный путь к каталогу (папке). Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Доступ к каталогу
DirectoryAccessible boolean

Возвращает значение true, если каталог доступен или false, если нет.

Доступ к каталогу неавторизован
DirectoryAccessUnauthorised boolean

Возвращает значение true, если каталог недоступен, так как разрешения ограничивают доступ к нему или значение false, если нет.

Заблокирован сеанс

Сообщает, заблокирован ли сеанс, в котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Сеанс заблокирован
SessionIsLocked boolean

Установите значение true, если сеанс, в котором запущен агент IA-Connect, заблокирован.

Задание положения графического интерфейса агента IA-Connect

Задает положение на экране графического интерфейса агента IA-Connect в указанное расположение.

Параметры

Имя Ключ Обязательно Тип Описание
X
X True integer

Координата X для задания агента в пикселях.

У
Y True integer

Координата Y для задания агента в пикселях.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Задание уровня журнала агента IA-Connect

Задает уровень ведения журнала агента IA-Connect для указанного значения (1 — самый низкий уровень и 4 — самый высокий).

Параметры

Имя Ключ Обязательно Тип Описание
Уровень журнала
LoggingLevel True integer

Уровень ведения журнала, на который должен быть задан агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Закрытие агента IA-Connect

Закрывает агент IA-Connect. Это не влияет на сеанс пользователя, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Секунды ожидания
SecondsToWait integer

Время ожидания перед выполнением команды закрытия, чтобы агент IA-Connect может сообщить о завершении команды.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Замена данных переменных в INI-файле

Обновляет одну переменную в файле INI.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу INI
InputFilename True string

Полный путь к INI-файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Путь к файлу INI выходных данных
OutputFilename string

Если вы хотите записать обновленный INI-файл в альтернативный файл, введите полный путь к выходному файлу здесь. Входной INI-файл будет не изменен. Выходной INI-файл будет содержать изменения.

Раздел поиска INI
SearchSection string

Необязательное имя раздела, в который нужно изменить переменную.

Имя переменной поиска INI
SearchVariable string

Имя переменной для обновления.

Данные замены
ReplaceData string

Данные замены для обновления переменной.

Кодировка файлов INI
InputFilenameEncoding string

Укажите кодировку ФАЙЛА INI (Юникод, UTF8, UTF7 или ASCII) или укажите значение кодирования (например, 1252 для Западной Европы).

Создайте новый файл, если входной файл не существует
CreateNewFileIfNotExists boolean

Если входной файл не существует, следует создать новый файл?

Запись пробела перед равным
WriteSpaceBeforeEquals boolean

Следует ли записывать пробел перед знаком равенства (= ) ?

Запись места после равного
WriteSpaceAfterEquals boolean

Должно ли пробел быть записано после знака equals (= ) ?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Запись в CSV-файл

Создает CSV-файл на компьютере, на котором запущен агент IA-Connect. CSV-файл создается из коллекции (таблицы) или из таблицы в формате JSON.

Параметры

Имя Ключ Обязательно Тип Описание
Свойства
Properties object
Входная таблица JSON
InputTableJSON string

Таблица данных для записи в CSV-файл в формате JSON.

Выходной путь к CSV-файлу
CSVFilePath True string

Полный путь к CSV-файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Кодирование выходных данных
OutputEncoding string

Формат кодирования текста, используемый при записи в CSV-файл. Поддерживаемые кодировки: UTF8, UTF7, Юникод и ASCII.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
WriteCollectionToCSVFileResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Запись в учетные данные пользователя

Записывает имя пользователя и пароль в учетные данные в профиле пользователя в сеансе агента IA-Connect, создавая эти учетные данные, если он не существует. Учетные данные можно просмотреть на панели управления Windows.

Параметры

Имя Ключ Обязательно Тип Описание
Адрес учетных данных
CredentialAddress True string

Имя или адрес учетных данных.

Имя пользователя
UserName True string

Имя пользователя учетных данных.

Пароль
Password True string

Пароль учетных данных.

Тип учетных данных
CredentialType True string

Тип учетных данных: Windows или Generic.

Сохраняемость учетных данных
CredentialPersistence string

Сохраняемость учетных данных: сеанс (длится только для этого сеанса входа), LocalMachine (сохраняется для этого пользователя в сеансах и перезагрузках только на этом компьютере) или Enterprise (может перемещаться для этого между компьютерами).

Симметричный ключ шифрования
SymmetricKey string

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

Хранение пароля в качестве идентификатора
StorePasswordAsIdentifier string

Если указан идентификатор, этот пароль также будет храниться в агенте для последующего получения или использования любыми командами, которые могут использовать сохраненные учетные данные. Эти пароли хранятся только в памяти и теряются при закрытии агента. Например: MyExchangePassword.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
CredentialWriteResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Запись текстового файла

Создает текстовый файл на компьютере, где выполняется агент IA-Connect и записывает текст в файл.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу
Filename True string

Полный путь к файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Текст для записи
TextToWrite string

Текстовое содержимое, записанное в файл.

Добавление существующего файла
AppendExistingFile boolean

Если файл уже существует, следует ли добавить новый текст для записи в конец существующего файла?

Кодировка
Encoding string

Укажите кодировку файла (Юникод, UTF8, UTF7 или ASCII) или оставьте пустым значение по умолчанию (UTF8).

Создание папки при необходимости
CreateFolderIfRequired boolean

Если папка, в которую хранится файл, указанный в параметре "Путь к файлу", не существует, следует ли создать эту папку?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Запуск альтернативного агента IA-Connect

Запускает альтернативный агент IA-Connect (например, более позднюю версию), загрузив исполняемый файл агента из расположения файла.

Параметры

Имя Ключ Обязательно Тип Описание
Filename
Filename True string

Полный путь к альтернативному IA-Connect Agent.exe для запуска. Этот путь должен быть доступен из сеанса, где в настоящее время запущен агент IA-Connect.

Arguments
Arguments string

Любые необязательные аргументы для передачи в IA-Connect Agent.exe при запуске.

Загрузка в память
LoadIntoMemory boolean

Следует ли запускать альтернативный агент IA-Connect в памяти? Если задано значение true, новый агент загружается в память и выполняется в сборке существующего агента. Если задано значение false, новый агент выполняется как обычный процесс, и существующий EXE-файл агента завершится.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Запуск альтернативного агента IA-Connect, отправляемого от директора

Запускает альтернативный агент IA-Connect (например, более позднюю версию), отправив альтернативный агент из директора IA-Connect, а затем загрузите альтернативный исполняемый файл агента.

Параметры

Имя Ключ Обязательно Тип Описание
Локальное имя файла
LocalFilename True string

Полный путь к альтернативному IA-Connect Agent.exe, который доступен от директора IA-Connect.

Удаленное имя файла
RemoteFilename string

Полный путь к расположению для копирования альтернативного IA-Connect Agent.exe (в удаленной системе). Если не указано, будет выбрано временное имя файла. Если альтернативный агент IA-Connect загружается в память, этот файл не будет создан (так как он не нужен), если только не задано значение "Сохранить на диск, даже если запущен из памяти" значение true. Это значение имеет значение true, если вы хотите использовать действия динамического кода IA-Connect, необходимые для получения ссылки на выполнение сборки (например, для доступа к IA-Connect внутренним методам).

Сжимать
Compress boolean

Следует ли сжимать исполняемый файл агента IA-Connect во время отправки?

Arguments
Arguments string

Любые необязательные аргументы для передачи в IA-Connect Agent.exe при запуске.

Разрешение на понижение уровня
PermitDowngrade boolean

Следует ли разрешить более ранние версии агента IA-Connect?

Пропустить проверку версии
SkipVersionCheck boolean

Следует ли проверять версию агентов IA-Connect (существующие и новые), что приведет к тому, что новая версия используется во всех сценариях (даже одна и та же версия)?

Загрузка в память
LoadIntoMemory boolean

Следует ли запускать альтернативный агент IA-Connect в памяти? Если задано значение true, новый агент загружается в память и выполняется в сборке существующего агента. Если задано значение false, новый агент выполняется как обычный процесс, и существующий EXE-файл агента завершится.

Сохранение на диск даже при запуске из памяти
SaveToDiskEvenIfRunningFromMemory boolean

Следует ли сохранить альтернативный агент IA-Connect на диск, даже если он выполняется в памяти? Это значение имеет значение true, если вы хотите использовать действия динамического кода IA-Connect, необходимые для получения ссылки на выполнение сборки (например, для доступа к IA-Connect внутренним методам).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Альтернативный скопированный файл
AlternativeFileCopied boolean

Сообщает, используется ли альтернативный агент IA-Connect.

Запуск процесса PowerShell

Запустите процесс PowerShell, выполняя существующий скрипт на диске или предоставляя содержимое скрипта для выполнения. Вместо этого рекомендуется использовать действие "Запуск скрипта PowerShell", которое гораздо эффективнее и предоставляет таблицу данных выходных данных из скрипта PowerShell. Используйте это действие, если скрипт PowerShell выводит стандартные выходные данные или стандартную ошибку (например, использует Write-Host вместо возврата таблицы), требует PowerShell 7 или выполняет действия Active Directory в качестве альтернативного пользователя, а CredSSP через WinRM недоступен.

Параметры

Имя Ключ Обязательно Тип Описание
Исполняемый файл PowerShell
PowerShellExecutable string

Путь к исполняемому файлу PowerShell. Оставьте значение по умолчанию "PowerShell.exe", чтобы запустить исполняемый файл PowerShell по умолчанию, как определено в пути к Windows. Используйте%SYSTEMROOT%\system32\WindowsPowerShell\v1.0\PowerShell.exeдля PowerShell 5.x. ИспользуйтеC:\Program Files\PowerShell\7\pwsh.exeдля PowerShell 7. Агент IA-Connect развернет все переменные среды в пути.

Путь к файлу скрипта PowerShell
PowerShellScriptFilePath string

Путь к существующему скрипту PowerShell для выполнения. Скрипт PowerShell должен быть доступен агентом IA-Connect (т. е. если агент работает в удаленном сеансе, сценарий должен находиться в удаленной системе или доступен из удаленной системы). Кроме того, оставьте этот вход пустым и предоставьте содержимое скрипта PowerShell во входных данных "Содержимое скрипта PowerShell". Агент IA-Connect развернет все переменные среды в пути.

Содержимое скрипта PowerShell
PowerShellScriptContents string

Содержимое скрипта PowerShell для выполнения вместо предоставления пути к существующему скрипту PowerShell.

Рабочая папка
WorkingDirectory string

Рабочая папка или каталог для скрипта PowerShell. Агент IA-Connect развернет все переменные среды в пути.

Создание окна без
CreateNoWindow boolean

Если задано значение true (по умолчанию), скрипт PowerShell будет выполняться невидимо. Если задано значение false, откроется окно скрипта PowerShell. Это может быть полезно, если скрипт PowerShell запрашивает входные данные, и вы планируете использовать UIA и глобальные действия мыши и клавиатуры для взаимодействия с ним.

Стиль окна
WindowStyle string

Укажите стиль окна (обычный, максимизированный, минимизированный или скрытый), если скрипт PowerShell настроен для выполнения заметно.

Ожидание процесса
WaitForProcess boolean

Следует ли агенту IA-Connect ожидать завершения скрипта PowerShell? По умолчанию это значение имеет значение true, чтобы разрешить агенту IA-Connect получать выходные данные из скрипта. Установите значение false для пожара и забыли.

Перенаправление стандартных выходных данных
RedirectStandardOutput boolean

Если задано значение true (по умолчанию), то стандартные выходные данные скрипта будут перенаправлены, позволяя агенту возвращать его в переменной StandardOutput. Это полезно, если вы хотите вернуть выходные данные из скрипта, в агент (например, выходные данные из Write-Host).

Стандартная ошибка перенаправления
RedirectStandardError boolean

Если задано значение true, будет перенаправлена стандартная ошибка скрипта, что позволит агенту вернуть его в переменной StandardError.

Перенаправление стандартной ошибки в выходные данные
RedirectStandardErrorToOutput boolean

Если задано значение true, стандартная ошибка скрипта будет перенаправлена на стандартные выходные данные, объединяя их в один выход.

Стандартная кодировка выходных данных
StandardOutputEncoding string

Укажите стандартную кодировку выходных данных (UTF8, UTF7, UTF16, ASCII или UTF16BE).

Стандартная кодировка ошибок
StandardErrorEncoding string

Укажите стандартную кодировку ошибок (UTF8, UTF7, UTF16, ASCII или UTF16BE).

Имя домена RunAs
RunAsDomain string

Домен запуска от имени пользователя. Если домен не указан, имя пользователя должно быть в формате username@domainFQDN.

Имя пользователя RunAs
RunAsUsername string

Имя пользователя запуска от имени пользователя.

Пароль запуска
RunAsPassword password

Пароль запуска от имени пользователя.

Загрузка профиля пользователя runAs
RunAsLoadUserProfile boolean

Должен ли быть загружен профиль пользователя Windows запуска от имени пользователя?

Повышенные привилегии RunAs
RunAsElevate boolean

Должен ли сценарий PowerShell выполняться с повышенными привилегиями? У вас может возникнуть крайняя трудность с принятием запроса на повышение уровня.

Время ожидания в секундах
TimeoutInSeconds integer

Максимальное количество секунд, дожидающегося завершения скрипта PowerShell.

Папка temp скрипта PowerShell
PowerShellScriptTempFolder string

По умолчанию, если вы предоставляете скрипт PowerShell в входных данных "Содержимое скрипта PowerShell", агент IA-Connect сохраняет скрипт в файл "%TEMP%\IA-Connect\TempPowerShell-{Date}-{Time}.ps1', passes it to PowerShell.exe через входные данные -File и удаляет файл после завершения скрипта. Этот путь по умолчанию может быть неприемлемым, если вы используете имя пользователя RunAs, так как пользователь RunAs может не иметь доступа к профилю учетной записи, работающей с агентом IA-Connect. Используйте эти входные данные для предоставления альтернативной папки. Например: '%SYSTEMDRIVE% emp'. Агент IA-Connect развернет все переменные среды в пути.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Начало процесса
ProcessStarted boolean

Возвращает значение true, если был запущен процесс скрипта PowerShell (PowerShell.exe).

Код выхода
ExitCode integer

Возвращает код выхода из скрипта PowerShell (PowerShell.exe).

Время ожидания процесса
ProcessTimedOut boolean

Возвращает значение true, если время ожидания процесса скрипта PowerShell (PowerShell.exe) истекло.

Идентификатор процесса
ProcessId integer

Идентификатор процесса процесса скрипта PowerShell (PowerShell.exe), который был запущен.

Стандартные выходные данные
StandardOutput string

Стандартное содержимое выходных данных.

Стандартная ошибка
StandardError string

Стандартное содержимое ошибки.

Запуск сеанса удаленного рабочего стола (RDS)

Запустите сеанс удаленного рабочего стола (RDS) с помощью файла запуска RDP.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу RDP
RDPFilePath True string

Полный путь к файлу RDP (который может существовать или быть создан с помощью действия: "Создание файла запуска сеанса удаленного рабочего стола (RDS) ".

Доверять удаленному компьютеру
TrustRemoteComputer boolean

Установите значение true, чтобы пометить удаленный адрес (заданный в файле RDP) как доверенный (в реестре Windows), в основном для целей перенаправления устройств, устраняя всплывающее окно, которое может быть получено при запуске RDP-файла.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
LaunchRemoteDesktopSessionResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Идентификатор процесса kill

Убивает выполняющийся процесс в сеансе пользователя агента IA-Connect с указанным идентификатором процесса. Идентификаторы процессов уникальны, поэтому только один процесс может соответствовать идентификатору. Идентификаторы процесса являются динамическими и отличаются для каждого запуска приложения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
ProcessID True integer

Идентификатор процесса, который требуется убить.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Число убитых процессов
NumberOfProcessesKilled integer

Число убитых процессов.

Изменение состояния задачи автоматизации Orchestrator

Изменяет состояние выбранной задачи автоматизации Orchestrator или другие свойства задачи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор задачи
TaskId True integer

Идентификатор задачи Orchestrator для изменения.

Новое состояние задачи автоматизации
AutomationTaskStatus string

Состояние новой задачи для указанной задачи автоматизации или оставьте пустым, если вы не хотите изменить состояние существующей задачи. Если вы хотите отложить существующую задачу, используйте действие "Отложить существующую задачу автоматизации Orchestrator".

Размещение задачи на удержание
TaskOnHold boolean

Укажите состояние задачи "В удержании". Только новые или отложенные задачи могут находиться на удержании, поэтому исключение будет возникать, если вы попытаетесь поместить любое другое состояние задачи на удержание.

Удаление входных данных задачи
EraseTaskInputData boolean

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

Удаление хранимых данных отсрочки
EraseDeferralStoredData boolean

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

Обновление исходной системы
UpdateSourceSystem boolean

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

Причина закрытия задачи
TaskClosureReason string

Укажите причину закрытия задачи для задач "Завершено" или "Сбой", которые будут храниться в задаче. Кроме того, если задача Orchestrator связана с исходной системой (например, ServiceNow), вы изменяете состояние и "Обновление исходной системы" имеет значение true, причина также будет передана исходной системе (например, как заметка о работе ServiceNow). Только завершенные или неудачные задачи могут иметь причину закрытия, поэтому исключение будет возникать при попытке и установке причины закрытия для любого другого состояния задачи.

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
TasksChangeTaskStatusResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Калибровка mouse_event

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

Параметры

Имя Ключ Обязательно Тип Описание
Размер калибровки в пикселях
CalibrationSizeInPixels integer

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Умножение мыши X
MouseXMultiplier double

Значение умножения X мыши. Значение 1.0 не указывает умножение.

Умножение мыши Y
MouseYMultiplier double

Значение умножения мыши Y. Значение 1.0 не указывает умножение.

Каталог очистки

Очищает каталог (папку) на компьютере, где выполняется агент IA-Connect, удаляя все файлы, хранящиеся в каталоге.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к каталогу
DirectoryPath True string

Полный путь к каталогу (папке). Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рекурсивный
Recursive boolean

Следует ли очистить все вложенные папки?

Удаление верхнего уровня
DeleteTopLevel boolean

Следует ли удалить папку верхнего уровня?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Копирование файла

Копирует файл на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к исходному файлу
SourceFilePath True string

Полный путь к исходному файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Путь к целевому файлу
DestFilePath True string

Полный путь к месту назначения, в который должен быть скопирован файл. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Копирование файла в буфер обмена

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

Параметры

Имя Ключ Обязательно Тип Описание
Имя файла
Filepath True string

Путь к локальному файлу, который необходимо скопировать в буфер обмена.

Резать
Cut boolean

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
CopyFileToClipboardResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Копирование файла с клиента на сервер

Копирует файл с локального компьютера (под управлением директора IA-Connect) на удаленный компьютер (запуск агента IA-Connect).

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу клиента
ClientFilePath True string

Путь к файлу для копирования файла (на локальном компьютере под управлением директора IA-Connect).

Путь к файлу сервера
ServerFilePath True string

Путь к файлу для копирования файла в (на компьютере под управлением агента IA-Connect).

Сжимать
Compress boolean

Следует ли сжимать файл при копировании?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Левая кнопка мыши вверх

Освобождает левую кнопку мыши в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Левая кнопка мыши вниз

Нажимает (и не освобождает) левую кнопку мыши в сеансе пользователя агента IA-Connect. Чтобы освободить мышь, используйте действие мыши слева.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Левая удерживаемая мышь

Удерживает левую кнопку мыши в сеансе пользователя агента IA-Connect в течение указанного количества секунд.

Параметры

Имя Ключ Обязательно Тип Описание
Удерживайте секунды
SecondsToHold True double

Количество секунд, удерживаемых на левой кнопке мыши.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Левая удерживаемая мышь в координате

Удерживает левую кнопку мыши по указанным координатам в сеансе пользователя агента IA-Connect в течение указанного количества секунд. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Параметры

Имя Ключ Обязательно Тип Описание
X пикселей
XCoord True integer

Значение координат X (в пикселях).

Y пикселей
YCoord True integer

Значение координаты Y (в пикселях).

Удерживайте секунды
SecondsToHold True double

Количество секунд, удерживаемых на левой кнопке мыши.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Назначение задачи автоматизации Orchestrator

Назначает выбранную задачу автоматизации Orchestrator указанному пользователю или группе. Это назначение будет передано исходной системе, связанной с этой задачей автоматизации (например, ServiceNow), и чаще всего используется для передачи билета другому лицу или группе людей для дополнительной обработки. Если задача автоматизации Orchestrator не связана с источником, создается исключение.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор задачи
TaskId True integer

Идентификатор задачи Orchestrator, назначаемой.

Назначение идентификатору пользователя
AssignToUserId string

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

Назначение имени пользователя
AssignToUserName string

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

Назначение идентификатору группы
AssignToGroupId string

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

Назначение имени группы
AssignToGroupName string

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

Удаление назначения пользователей, если пустое
RemoveUserAssignmentIfBlank boolean

Если поля назначения пользователей пусты, и это поле имеет значение true, любой назначенный в данный момент пользователь будет удален, в противном случае назначения пользователей останутся неизменными.

Удаление назначения группы, если пустое
RemoveGroupAssignmentIfBlank boolean

Если поля назначения группы пусты, и это поле имеет значение true, любая назначенная в данный момент группа будет удалена, в противном случае назначения групп останутся неизменными.

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
TasksAssignTaskResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Настройка буфера обмена

Задает содержимое буфера обмена в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Новые данные буфера обмена
NewClipboardData string

Данные, которые необходимо задать в буфере обмена.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Настройка выходных данных задачи автоматизации Orchestrator

Задает выходные данные для задачи автоматизации Orchestrator. Обычно используется при выполнении задачи и требуется предоставить выходные данные, собираемые процессом, создавшего задачу.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор задачи
TaskId True integer

Идентификатор задачи Orchestrator для добавления заметки.

Выходные данные задачи
TaskOutputData string

Строка выходных данных. Это можно отформатировать как любой текстовый формат выбранного текста, например JSON или XML или необработанный текст. Строку выходных данных можно просмотреть в пользовательском интерфейсе Orchestrator или получить к ним доступ с помощью REST API TasksGetTask.

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
TasksSetOutputDataResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Настройка глобальной конфигурации координат агента IA-Connect

Настраивает глобальную систему координат агента IA-Connect, которая используется для отображения расположений элементов (например, во время проверки мыши) и вычисления позиций мыши (например, при выполнении глобальных действий мыши). Значения по умолчанию предоставляют последние функциональные возможности, но вы можете использовать это действие, чтобы вернуться к поведению в предыдущих версиях агента или указать, что API использует другую систему координат.

Параметры

Имя Ключ Обязательно Тип Описание
Функции нескольких мониторов
MultiMonitorFunctionality string

Установите значение "Только основное отображение" (PrimaryMonitor), чтобы вернуться к более старому поведению, которое поддерживает только выделение элементов и выполнение глобальных действий мыши на основном устройстве отображения (единственный доступный режим в IA-Connect 9.3 и более ранних версий). Установите значение "Все отображения" (MultiMonitor), чтобы включить выделение элементов и выполнение глобальных действий мыши на всех мониторах, а также для автоматического обнаружения масштабирования DPI на каждом мониторе (по умолчанию с IA-Connect 9.4). Установите значение "Не задано" (NotSet), чтобы не вносить изменений.

Автоматическое определение умножения проверки мыши
AutoSetMouseInspectionMultiplier string

Установите значение Auto (1) (значение по умолчанию с IA-Connect 9.4), чтобы автоматически вычислить умножение проверки мыши на основном устройстве отображения при запуске агента и при каждом выполнении проверки мыши. Установите значение "Вручную" (0), чтобы требовать, чтобы умножитель проверки был установлен вручную (единственный доступный параметр в IA-Connect 9.3 и более ранних версий). Установите значение "Пустой" или "NotSet", чтобы оставить этот параметр неизменным. Этот параметр действует только в том случае, если отключена функция многоконтрольного монитора.

Автоматическое определение глобального умножения мыши
AutoSetGlobalMouseMultiplier string

Установите значение Auto (1) (значение по умолчанию с IA-Connect 9.4), чтобы автоматически вычислить глобальный умножитель перемещения мыши на основном устройстве отображения при запуске агента и каждый раз, когда выполняется проверка мыши. Для параметра "Вручную" (0) необходимо, чтобы глобальный умножитель перемещения мыши был установлен вручную (единственный доступный параметр в IA-Connect 9.3 и более ранних версий). Установите значение "Пустой" или "NotSet", чтобы оставить этот параметр неизменным. Этот параметр действует только в том случае, если отключена функция многоконтрольного монитора.

Мультипликатор проверки мыши X
MouseInspectionXMultiplier double

Умножитель проверки мыши по горизонтали (X) для задания (если агент выделяет то, что находится под мышью). Например, если IA-Connect отображает прямоугольник проверки в половине фактического расположения мыши X, задайте значение 0,5. Установите значение 0, чтобы оставить текущее значение без изменений. Этот параметр действует только при отключении функции многоконтрольного монитора и отключена функция автоматической проверки мыши.

Умножитель проверки мыши Y
MouseInspectionYMultiplier double

Умножение проверки мыши по вертикали (Y) для задания (если агент выделяет то, что находится под мышью). Например, если IA-Connect отображает прямоугольник проверки в половине фактического расположения мыши Y, задайте значение 0,5. Установите значение 0, чтобы оставить текущее значение без изменений. Этот параметр действует только при отключении функции многоконтрольного монитора и отключена функция автоматической проверки мыши.

Глобальный умножитель мыши X
GlobalMouseXMultiplier double

Глобальный умножитель перемещения мыши по горизонтали (X) для задания (если агент перемещает мышь). Установите значение 0, чтобы оставить текущее значение без изменений. Этот параметр действует только в том случае, если отключена функция многоконтрольного монитора.

Глобальный умножитель мыши Y
GlobalMouseYMultiplier double

Умножение глобального перемещения мыши по вертикали (Y) для задания (для того, чтобы агент перемещал мышь). Установите значение 0, чтобы оставить текущее значение без изменений. Этот параметр действует только в том случае, если отключена функция многоконтрольного монитора.

Применимо к mouse_event
GlobalMouseMultiplierApplyToMouseEvent boolean

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

Применение к SetCursorPos
GlobalMouseMultiplierApplyToSetCursorPos boolean

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

Применение к текущему методу перемещения мыши
GlobalMouseMultiplierApplyToCurrentMouseMoveMethod boolean

Этот аргумент указывает, следует ли применять глобальные значения умножения мыши к текущему методу перемещения мыши (например, если SetCursorPos является текущим методом перемещения мыши, умножение будет применяться к SetCursorPos). Если задано значение true, входные данные "Применить к mouse_event" и "Применить к SetCursorPos" игнорируются. Этот параметр действует только в том случае, если отключена функция многоконтрольного монитора.

Система координат Java
JavaCoordinateSystem string

Установите значение Virtual (по умолчанию и единственный доступный параметр в IA-Connect 9.3 и более ранних версий), чтобы сообщить агенту, что мост доступа Java предоставляет виртуальные (масштабируемые DPI) координаты. Установите значение "Физический", чтобы сообщить агенту, что мост доступа Java предоставляет физические координаты (которые сопоставляют непосредственно с пикселями). Установите значение "Не задано" (NotSet), чтобы не вносить изменений.

Система координат SAP GUI
SAPGUICoordinateSystem string

Установите значение Virtual (по умолчанию и единственный доступный вариант в IA-Connect 9.3 и более ранних версий), чтобы сообщить агенту, что API скриптов SAP GUI предоставляет виртуальные (масштабируемые) координаты. Установите значение "Физический", чтобы сообщить агенту, что API скриптов SAP GUI предоставляет физические координаты (которые сопоставляют непосредственно с пикселями). Установите значение "Не задано" (NotSet), чтобы не вносить изменений.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
SetAgentGlobalCoordinateConfigurationResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Настройка директора IA-Connect следующего прыжка

Настройте директор следующего прыжка в сценарии двойного прыжка. Это необходимо только в том случае, если параметры директора следующего прыжка по умолчанию IA-Connect не подходят.

Параметры

Имя Ключ Обязательно Тип Описание
Включено SOAP
SOAPEnabled boolean

Следует ли включить интерфейс SOAP в директоре следующего прыжка?

REST включено
RESTEnabled boolean

Следует ли включить интерфейс REST в директоре следующего прыжка?

Веб-сервер включен
WebServerEnabled boolean

Следует ли включить веб-сервер (для размещения инспектора IA-Connect) в директоре следующего прыжка?

Только директор localhost
DirectorIsLocalhostOnly boolean

Должны ли интерфейсы SOAP и REST директора прослушивать только localhost? Это значение должно иметь значение true, так как ни один другой компьютер не должен взаимодействовать с этими интерфейсами.

TCP-порт SOAP
SOAPTCPPort integer

Если интерфейс SOAP включен, какой TCP-порт должен выполняться (по умолчанию — 8002)?

TCP-порт REST
RESTTCPPort integer

Если интерфейс REST включен, какой TCP-порт должен выполняться (по умолчанию — 8002)?

SOAP использует ПРОТОКОЛ HTTPS
SOAPUsesHTTPS boolean

Используется ли интерфейс SOAP с помощью HTTPS (вместо HTTP)? Если задано значение True, сертификат требуется на компьютере первого прыжка для упрощения HTTPS. К этому можно предоставить общий доступ с сертификатом, используемым для REST.

REST использует ПРОТОКОЛ HTTPS
RESTUsesHTTPS boolean

Интерфейс REST использует ПРОТОКОЛ HTTPS (вместо HTTP)? Если задано значение True, сертификат требуется на компьютере первого прыжка для упрощения HTTPS. Это можно предоставить совместно с сертификатом, используемым для SOAP.

Добавочный TCP-порт директора по SessionId
IncrementDirectorTCPPortBySessionId boolean

Чтобы гарантировать, что TCP-порт директора является уникальным (если существует несколько параллельных сеансов с использованием двойного прыжка с одного узла первого прыжка), идентификатор сеанса первого прыжка можно добавить в tcp-порт директора. Это необходимо только в том случае, если протокол SOAP или REST включен в директоре первого прыжка, и они обычно не включены, так как именованные каналы используются по умолчанию.

SOAP использует проверку подлинности пользователей
SOAPUsesUserAuthentication boolean

Установите значение True, если требуется, чтобы tcp-порт HTTP SOAP использовал проверку подлинности пользователя. Дополнительные сведения о настройке см. в руководстве по установке IA-Connect.

REST использует проверку подлинности пользователей
RESTUsesUserAuthentication boolean

Установите значение True, если требуется, чтобы TCP-порт HTTP REST использовал проверку подлинности пользователя. Дополнительные сведения о настройке см. в руководстве по установке IA-Connect.

Включен именованный канал команд
CommandNamedPipeEnabled boolean

Следует ли агенту первого прыжка использовать именованные каналы для взаимодействия с директором первого прыжка? Это метод связи по умолчанию.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Настройка ключа лицензии IA-Connect

Лицензирует агент IA-Connect с помощью ключа лицензии. Это может быть строка лицензии или понятное имя лицензии, удерживаемой в IA-Connect Orchestrator.

Параметры

Имя Ключ Обязательно Тип Описание
Ключ лицензии
LicenseString True string

Строка ключа лицензии IA-Connect или понятное имя лицензии, удерживаемой в IA-Connect Orchestrator (при управлении IA-Connect с помощью оркестратора IA-Connect).

Хранение в реестре
StoreInRegistry boolean

Следует ли временно хранить лицензию IA-Connect в реестре? Это гарантирует, что агент IA-Connect будет лицензирован в течение сеанса пользователя, даже если агент закрыт и повторно запущен.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Дни до истечения срока действия лицензии
DaysUntilLicenseExpires integer

Количество оставшихся дней до истечения срока действия лицензии IA-Connect.

Настройка кода лицензии IA-Connect

Отправляет лицензию на домен агента старого стиля (7.0 и 7.1) в агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Доменное имя Клиента NetBIOS
CustomerNETBIOSDomainName True string

Доменное имя netBIOS компьютера, на котором выполняется агент IA-Connect.

Отображаемое имя клиента
CustomerDisplayName True string

Имя клиента, отображаемое в строке заголовка агента IA-Connect.

Имя поставщика
VendorName True string

Имя поставщика IA-Connect.

Дата окончания срока действия лицензии
LicenseExpiryDate True string

Дата окончания срока действия лицензии IA-Connect.

Код активации
ActivationCode True string

Код активации для лицензии IA-Connect.

Хранение в реестре
StoreInRegistry boolean

Следует ли временно хранить лицензию IA-Connect в реестре? Это гарантирует, что агент IA-Connect будет лицензирован в течение сеанса пользователя, даже если агент закрыт и повторно запущен.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Настройка непрозрачности графического интерфейса агента IA-Connect

Задает прозрачность агента IA-Connect от 1 (видимо) до 0 (прозрачно).

Параметры

Имя Ключ Обязательно Тип Описание
Непрозрачность
Opacity True double

Значение прозрачности, которое необходимо задать, от 1 (видимо) до 0 (прозрачно).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Настройка режима обслуживания рабочей роли Orchestrator

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор рабочей роли
WorkerId integer

Идентификатор рабочей роли. Это целочисленное значение (1 или выше), внутреннее для Оркестратора. Идентификатор рабочей роли можно определить, просмотрев сведения о рабочей роли в пользовательском интерфейсе Orchestrator и найдите идентификатор в URL-адресе браузера. Если вы хотите найти рабочую роль по имени, задайте для этого значения значение 0 и введите имя в поле "Имя рабочей роли".

Имя работника
WorkerName string

Имя рабочей роли. Это приведет к тому, что Оркестратор будет выполнять поиск по списку работников для рабочей роли с указанным именем. При поиске по имени задайте для параметра "Рабочий идентификатор" значение 0 (чтобы отключить использование идентификатора рабочей роли).

Режим обслуживания
MaintenanceMode boolean

Установите значение true (по умолчанию), чтобы включить режим обслуживания, поэтому потоки не назначаются рабочей роли. Установите значение false, чтобы оставить режим обслуживания, что позволяет назначать потоки рабочей роли (если рабочий не запрещен другими правилами).

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
SetOrchestratorWorkerMaintenanceModeResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Настройка средства чтения с экрана

Включает или отключает средство чтения с экрана в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Включение средства чтения с экрана
EnableScreenReader boolean

Если задано значение true, средство чтения с экрана будет включено. Если задано значение false, средство чтения с экрана будет отключено.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Настройка уровня журнала IA-Connect директора

Задает уровень ведения журнала IA-Connect директора указанным значением. Уровни ведения журнала задаются от 0 до 4. Значение 0 отключено. 1 — самый низкий уровень журнала (и по умолчанию). 4 — самый высокий уровень журнала.

Параметры

Имя Ключ Обязательно Тип Описание
Уровень журнала
LoggingLevel True integer

Уровень ведения журнала, на который должен быть установлен директор IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Обновление результата статистики потока Orchestrator

Обновите статистику результатов для текущего рабочего потока в IA-Connect Orchestrator. Это используется для изменения окончательного результата статистики потока в IA-Connect Orchestrator, который обычно используется для создания отчетов. Это работает только для текущего потока (Оркестратор обнаруживает идентификатор выполнения потока). Невозможно изменить статистику для любого другого потока.

Параметры

Имя Ключ Обязательно Тип Описание
Выполнение последнего действия потока
FlowLastActionSuccess boolean

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

Сообщение об ошибке последнего действия потока
FlowLastActionErrorMessage string

Если указать, что последнее действие Flow было сбоем, укажите здесь сообщение об ошибке.

Код последнего действия потока
FlowLastActionCode integer

Необязательный код для назначения статистике flow. Обычно это используется в качестве кода ошибки (например, для различения исключений системы и бизнеса), но может использоваться в качестве кода успешного выполнения.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
UpdateOrchestratorFlowStatsResultResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Остановка активности сеанса

Останавливает сеанс пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
StopKeepSessionAliveResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Отвечает ли TCP-порт

Сообщает, отвечает ли сетевой TCP-порт на попытку подключения агентом IA-Connect. Это может быть TCP-порт на компьютере, на котором запущен агент IA-Connect (введите localhost для удаленного узла) или на любом удаленном компьютере. Если агент IA-Connect успешно подключается к TCP-порту, он немедленно закрывает TCP-подключение.

Параметры

Имя Ключ Обязательно Тип Описание
Удаленный узел
RemoteHost True string

IPv4-адрес, DNS-адрес или имя узла компьютера для подключения. Введите localhost, чтобы проверить TCP-порт на компьютере, на котором запущен агент IA-Connect. Примеры: 192.168.1.10 или www.test.com или vm-server19.

TCP-порт
TCPPort True integer

Номер TCP-порта для подключения к указанному удаленному (или локальному) узлу. TCP-порт должен быть 1 или выше, а 65535 или ниже. Примерами распространенных известных портов являются 80 (HTTP), 443 (HTTPS), 445 (SMB / общий доступ к файлам).

Время ожидания в секундах
TimeoutInSeconds integer

Максимальное количество секунд ожидания TCP-подключения. По умолчанию это значение составляет 10 секунд, но большинство рабочих подключений должно быть подключено в течение нескольких секунд (через Интернет) или менее секунды (локальная сеть).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Подключенный TCP-порт
TCPPortConnected boolean

Установите значение true, если TCP-порт подключен или false, если tcp-порт не удалось подключиться.

Сообщение об ошибке подключения
ConnectionErrorMessage string

Сообщение об ошибке, если tcp-порт не удалось подключиться. Обычно это будет ошибка подстановки DNS или имени или время ожидания.

Отключение IA-Connect следующего прыжка

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

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Отключение удаленного сеанса

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

Параметры

Имя Ключ Обязательно Тип Описание
Секунды ожидания
SecondsToWait integer

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

Не отключайте, если локальный агент
DoNotDisconnectIfLocalAgent boolean

Если задано значение true, а агент IA-Connect работает в локальном сеансе (т. е. непосредственно в рабочей роли), это действие будет автоматически игнорироваться. Это полезно, так как отключение локального агента заблокирует сеанс и, следовательно, ограничивает функции RPA, пока сеанс не будет разблокирован.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Отложить существующую задачу автоматизации Orchestrator

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор задачи
TaskId True integer

Идентификатор существующей задачи автоматизации Orchestrator, которая будет отложить (или снова отложить).

Время отсрочки в минутах
DeferralTimeInMinutes integer

Сколько минут должно быть отложено задаче автоматизации.

Отсрочка хранимых данных
DeferralStoredData string

Необязательные данные для хранения с этой задачей. Он станет доступным для процесса или потока, когда он продолжается с отсрочки. Обычно это используется для хранения данных, вычисляемых во время процесса или потока, которые необходимо снова получить после отсрочки. Вы можете хранить данные в любом формате, но JSON — это часто используемый формат.

Этап процесса
ProcessStage string

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

Priority
Priority integer

Задайте уровень приоритета этой задачи (1 — самый высокий уровень).

Размещение задачи на удержание
TaskOnHold boolean

Если для этого значения задано значение true, задача будет помещена в удержание и поэтому не будет обрабатываться в типичном рабочем процессе задачи, даже если достигнута дата отсрочки. Состояние "В удержании" можно изменить позже с помощью действия "Изменение состояния задачи автоматизации Orchestrator".

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
TasksDeferExistingTaskResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Отложить существующую операцию автоматизации Orchestrator

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор операции
OperationId True string

Идентификатор операции задачи Orchestrator, чтобы отложить (или снова отложить).

Время отсрочки в минутах
DeferralTimeInMinutes integer

Сколько минут должно быть отложено задаче автоматизации.

Отсрочка хранимых данных
DeferralStoredData string

Необязательные данные для хранения с этой задачей. Он станет доступным для процесса или потока, когда он продолжается с отсрочки. Обычно это используется для хранения данных, вычисляемых во время процесса или потока, которые необходимо снова получить после отсрочки. Вы можете хранить данные в любом формате, но JSON — это часто используемый формат.

Этап процесса
ProcessStage string

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

Priority
Priority integer

Задайте уровень приоритета этой задачи (1 — самый высокий уровень).

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
TasksDeferExistingTaskOperationResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Отправка ключевых событий

Отправляет события глобального нажатия клавиши в сеанс пользователя агента IA-Connect с помощью драйвера клавиатуры низкого уровня. Это имитирует пользователя, нажимая эти клавиши на клавиатуре. Убедитесь, что целевой элемент Window сосредоточен, или нажатия клавиш могут быть получены неправильным приложением или игнорироваться.

Параметры

Имя Ключ Обязательно Тип Описание
Текст
Text True string

Нажатие клавиши для ввода в сеанс пользователя агента IA-Connect с помощью драйвера клавиатуры низкого уровня. Ключевые коды описаны в синтаксисе "Отправить ключевые события" в руководстве пользователя пользовательского интерфейса. Пример для нажатия и выпуска escape: {Escape}. Пример нажатия клавиши Win+D для отображения рабочего стола (слева от клавиши Windows, нажатия клавиши d и выпуска d, выпуска): <{LWin}d>{LWin}}. Пример нажатия клавиш CTRL+C (удручающее левое управление, нажатие и освобождение c, левый элемент управления): <{CTRL}c>{CTRL}. Не забудьте освободить депрессивные ключи или они останутся подавленными (например, если вы используете < для депрессии клавиши модификатора, используйте > его для освобождения).

Интервал в миллисекундах
Interval integer

Количество миллисекунда между каждым событием нажатия клавиши.

Пароль
IsPassword boolean

Является ли входным значением пароля? В этом случае следует использовать альтернативное действие "Отправить события ключа пароля".

Не интерпретируемые символы
DontInterpretSymbols boolean

Не следует ли интерпретировать символы в тексте как специальные ключи (например, {SHIFT} для shift, {CTRL} для CTRL)? Это значение должно иметь значение true, если вы пытаетесь ввести фактические символы.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Отправка ключей

Отправляет глобальные клавиши в сеанс пользователя агента IA-Connect. Это имитирует пользователя, нажимая эти клавиши на клавиатуре. Убедитесь, что целевой элемент Window сосредоточен, или нажатия клавиш могут быть получены неправильным приложением или игнорироваться.

Параметры

Имя Ключ Обязательно Тип Описание
Текст
Text True string

Нажатие клавиши, имитируемой в сеансе пользователя агента IA-Connect. Коды ключей описаны в синтаксисе "Отправить ключи" в руководстве пользователя пользовательского интерфейса. Для ввода буквенно-цифровых символов просто укажите текст as-is. Пример нажатия клавиш CTRL+C: ^c. Пример нажатия клавиш ALT+F: %f.

Интервал в миллисекундах
Interval integer

Количество миллисекунда между каждым нажатием клавиши.

Пароль
IsPassword boolean

Является ли входным значением пароля? В этом случае следует использовать альтернативное действие "Отправить ключи паролей".

Не интерпретируемые символы
DontInterpretSymbols boolean

Должны ли символы в тексте не интерпретироваться как специальные ключи (например, +для SHIFT, ^ для CTRL)? Это значение должно иметь значение true, если вы пытаетесь ввести фактические символы.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Отправка ключей паролей

Отправляет глобальные клавиши в сеанс пользователя агента IA-Connect специально для ввода пароля. Это имитирует пользователя, нажимая эти клавиши на клавиатуре. Убедитесь, что целевой элемент Window сосредоточен, или нажатия клавиш могут быть получены неправильным приложением или игнорироваться.

Параметры

Имя Ключ Обязательно Тип Описание
Пароль
Password True password

Ввод пароля с помощью имитированных клавиш в сеансе пользователя агента IA-Connect. Коды ключей описаны в синтаксисе "Отправить ключи" в руководстве пользователя пользовательского интерфейса. Если это пароль "Сохраненный", введите в формате {IAConnectPassword:StoredPasswordIdentifier} и задайте для входных данных "сохраненный пароль" значение true. Если это универсальные учетные данные Orchestrator, введите в формате {OrchestratorCredential:FriendlyName} и задайте для входных данных "сохраненный пароль" значение true.

Интервал в миллисекундах
Interval integer

Количество миллисекунда между каждым нажатием клавиши.

Не интерпретируемые символы
DontInterpretSymbols boolean

Должны ли символы в пароле не интерпретироваться как специальные ключи (например, +для SHIFT, ^ для CTRL)? Это значение должно иметь значение true, если вы пытаетесь ввести фактические символы.

Пароль содержит сохраненный пароль
PasswordContainsStoredPassword boolean

Задайте значение true, если пароль является IA-Connect сохраненным идентификатором пароля (например, созданным действием "Создать пароль") или универсальными учетными данными оркестратора IA-Connect (например, при использовании IA-Connect с потоком PA).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Отправка событий ключа пароля

Отправляет события глобального нажатия клавиши в сеанс пользователя агента IA-Connect, специально для ввода пароля с помощью драйвера клавиатуры низкого уровня. Это имитирует пользователя, нажимая эти клавиши на клавиатуре. Убедитесь, что целевой элемент Window сосредоточен, или нажатия клавиш могут быть получены неправильным приложением или игнорироваться.

Параметры

Имя Ключ Обязательно Тип Описание
Пароль
Password True password

Пароль, который необходимо ввести в сеанс пользователя агента IA-Connect с помощью драйвера клавиатуры низкого уровня. Ключевые коды описаны в синтаксисе "Отправить ключевые события" в руководстве пользователя пользовательского интерфейса. Если это пароль "Сохраненный", введите в формате {IAConnectPassword:StoredPasswordIdentifier} и задайте для входных данных "сохраненный пароль" значение true. Если это универсальные учетные данные Orchestrator, введите в формате {OrchestratorCredential:FriendlyName} и задайте для входных данных "сохраненный пароль" значение true.

Интервал в миллисекундах
Interval integer

Количество миллисекунда между каждым событием нажатия клавиши.

Не интерпретируемые символы
DontInterpretSymbols boolean

Должны ли символы в пароле не интерпретироваться как специальные ключи (например, {SHIFT} для shift, {CTRL} для CTRL)? Это значение должно иметь значение true, если вы пытаетесь ввести фактические символы.

Пароль содержит сохраненный пароль
PasswordContainsStoredPassword boolean

Задайте значение true, если пароль является IA-Connect сохраненным идентификатором пароля (например, созданным действием "Создать пароль") или универсальными учетными данными оркестратора IA-Connect (например, при использовании IA-Connect с потоком PA).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Отправка сообщения в веб-API

Отправьте сообщение в веб-API и получите ответ. Это можно использовать с любым веб-API, но обычное использование будет REST API. IA-Connect поддерживает отправку сообщений веб-API из виртуальной машины (например, для доступа к локальным ресурсам) или сеансов Citrix или Microsoft Remote Desktop (например, для доступа к API только из изолированных сред).

Параметры

Имя Ключ Обязательно Тип Описание
URL
URL string

Полный URL-адрес API для отправки сообщения. Например: https://myapi.remotesystem.com/path/action.

Метод
Method string

Используемый метод HTTP. Это должно соответствовать ожидаемым от удаленного API.

Время ожидания в секундах
TimeoutInSeconds integer

Количество секунд ожидания ответа. Если время ожидания достигнуто до получения HTTP-ответа, создается исключение.

Тип контента
ContentType string

Тип контента для передаваемых данных в тексте сообщения (если он присутствует). Это должно соответствовать ожидаемому от удаленного API. При вызове REST API, который ожидает полезные данные JSON в тексте, тип контента, скорее всего, будет application/json; charset=utf-8.

Принять
Accept string

Допустимые форматы для данных ответа. Это должно соответствовать ожидаемому от удаленного API. При вызове REST API, который возвращает полезные данные JSON, приемное значение, скорее всего, будет приложением или json. Чтобы принять любой ответ, введите /.

Текст сообщения
MessageBody string

При вызове веб-API, который ожидает данные в тексте сообщения (обычно с PUT, POST, PATCH), введите содержимое текста в этот вход. При вызове REST API это, скорее всего, будет содержать данные JSON. При вызове REST API, который ожидает данные JSON, но данные не отправляются, может потребоваться ввести {} эти входные данные. По умолчанию используется кодировка UTF-8, но ее можно изменить с помощью входных данных "Кодировка".

Кодировка передачи
TransmitEncoding string

Кодировка для передаваемого текста сообщения (если присутствует). Кодировки UTF используются для передачи данных Юникода. BE является большим эндианом.

Кодировка ответа
ResponseEncoding string

Кодировка данных ответа в теле ответа (если она присутствует). Весьма вероятно, что кодировка ответа будет соответствовать кодировке передачи. Кодировки UTF используются для передачи данных Юникода. BE является большим эндианом.

Размер буфера
BufferSize integer

Размер каждого отдельного считывания из выходного потока. Вряд ли это потребуется изменить. Это не ограничивает размер ответа; Это размер блока.

Недвижимость
Property string
Ценность
Value string
Согласование TLS 1.0
NegotiateTLS10 boolean

Если безопасность HTTPS и TLS 1.0 должна быть согласована с удаленной системой. Вы можете договориться о нескольких уровнях безопасности TLS, и будет использоваться самый высокий общий уровень согласования между клиентом и удаленной системой. Предупреждение: TLS 1.0 не рекомендуется использовать, поэтому не следует включать, если удаленная система не поддерживает более высокий уровень (возможно, старый и потенциально неподдерживаемый), и вы понимаете и принимаете риски безопасности.

Согласование TLS 1.1
NegotiateTLS11 boolean

При использовании безопасности HTTPS и TLS 1.1 следует согласовывать с удаленной системой. Вы можете договориться о нескольких уровнях безопасности TLS, и будет использоваться самый высокий общий уровень согласования между клиентом и удаленной системой. Предупреждение: TLS 1.1 не рекомендуется использовать, поэтому не следует включать, если удаленная система не поддерживает более высокий уровень (возможно, старый и потенциально неподдерживаемый), и вы понимаете и принимаете риски безопасности.

Согласование TLS 1.2
NegotiateTLS12 boolean

При использовании безопасности HTTPS и TLS 1.2 должно быть согласовано с удаленной системой. Вы можете договориться о нескольких уровнях безопасности TLS, и будет использоваться самый высокий общий уровень согласования между клиентом и удаленной системой. TLS 1.2 — это минимальный рекомендуемый уровень безопасности.

Согласование TLS 1.3
NegotiateTLS13 boolean

При использовании безопасности HTTPS и TLS 1.3 должно быть согласовано с удаленной системой. Вы можете договориться о нескольких уровнях безопасности TLS, и будет использоваться самый высокий общий уровень согласования между клиентом и удаленной системой. TLS 1.3 поддерживается только Windows 11 и более поздних версий, а также Server 2022 и более поздних версий.

Сохранение активности
KeepAlive boolean

Установите значение true, если необходимо включить сохранение активности. Это повторно использует TCP-подключение, если вы выполняете несколько запросов API в одну и ту же конечную точку в течение короткого интервала времени (менее минуты) и, следовательно, повышает производительность. Установите значение false, если вы планируете выполнять только один вызов API, или время между вызовами API составляет более минуты. При неправильной настройке этого может быть минимальным вредом, так как это влияет только на производительность.

Ожидается, что 100 продолжить
Expect100Continue boolean

Установите значение true, если вы используете запрос POST, отправляя большой объем данных и хотите определить, будет ли сервер принимать запрос, прежде чем отправлять данные. False лучше всего работает в большинстве сценариев, так как он уменьшает количество пакетов, отправленных на сервер, повышая время отклика.

Возврат заголовков ответов
ReturnResponseHeaders boolean

Установите значение true, если вы хотите, чтобы агент IA-Connect возвращал заголовки HTTP, полученные из удаленной системы, в ответе. Ответ будет иметь формат JSON. Используйте эту функцию, только если планируется обработать заголовки ответа для информации (например, возвращенный файл cookie), так как он увеличивает размер ответа.

Запуск от имени потока
RunAsThread boolean

Если задано значение false, агент IA-Connect немедленно запустит действие и возвращает результаты после завершения действия, но завершится ошибкой, если это займет больше времени ожидания рабочей или командной команды RPA. Если задано значение true, агент IA-Connect будет выполнять это действие в качестве потока агента и отслеживать его до завершения. Это позволяет выполнять действие дольше, чем время ожидания рабочей или командной команды RPA.

Ожидание потока
WaitForThread boolean

Используется только в том случае, если для потока запуска от имени задано значение true. Задайте для этого входного значения значение true, чтобы ждать завершения потока агента; Агент будет ждать до тех пор, пока указано время ожидания в секундах. Установите значение false, чтобы обойти ожидание; Агент будет продолжать выполнять действие в фоновом режиме, но также будет доступен для следующего действия. Затем можно получить результаты позже с помощью действия "Ожидание успешного завершения потока агента", чтобы дождаться завершения потока агента, а затем повторно запустить это действие с входным параметром "Получение выходных данных для идентификатора потока" для идентификатора потока агента.

Получение выходных данных для идентификатора потока
RetrieveOutputDataFromThreadId integer

Если ранее для параметра "Ожидание потока" задано значение false (что приводит к тому, что агент выполняет ожидание в фоновом потоке), укажите идентификатор потока агента для получения результатов. Этот идентификатор потока агента будет предоставлен предыдущим вызовом этого действия. В противном случае задайте значение 0 (значение по умолчанию).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Код состояния ответа
ResponseStatusCode integer

Код ответа HTTP. Распространенные успешные ответы: 200 (ОК), 201 (создано), 202 (принято). Коды ответов 3xx — это сообщения перенаправления. Коды ответа 4xx — это сообщения об ошибках клиента (например, если с запросом произошло что-то неправильное). Коды ответов 5xx — это сообщения об ошибках сервера. Коды откликов 4xx и 5xx, как правило, не отображаются в этих выходных данных, так как вместо этого будет создано исключение.

Ответное сообщение
ResponseMessage string

Содержимое сообщения ответа из текста ответа HTTP.

Тип контента ответа
ResponseContentType string

Тип контента текста ответа, если имеется текст ответа, и если тип был предоставлен.

Заголовки ответов JSON
ResponseHeadersJSON string

Если для входных данных "Возвращаемые заголовки ответа" задано значение true, этот результат будет содержать заголовки ответа HTTP в формате JSON. Используйте эту функцию, только если планируется обработать заголовки ответа для информации (например, возвращенный файл cookie), так как он увеличивает размер ответа.

Идентификатор потока
ThreadId integer

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

Очистка буфера обмена

Очищает содержимое буфера обмена в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Переместить файл

Перемещает файл на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к исходному файлу
SourceFilePath True string

Полный путь к исходному файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Путь к целевому файлу
DestFilePath True string

Полный путь к месту назначения, в который должен быть перемещен файл. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Перемещение мыши в координату

Перемещает мышь в сеансе пользователя агента IA-Connect на указанные координаты пикселей. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Параметры

Имя Ключ Обязательно Тип Описание
X пикселей
XCoord True integer

Значение координат X (в пикселях), на которое перемещается мышь.

Y пикселей
YCoord True integer

Значение координат Y (в пикселях) для перемещения мыши в.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Перемещение мыши между координатами

Перемещает мышь между двумя указанными координатами в сеансе пользователя агента IA-Connect. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат. Необязательный jitter поддерживается в движении мыши, чтобы сделать его более похожим на движение человеческой руки.

Параметры

Имя Ключ Обязательно Тип Описание
Запуск X пикселей
StartXCoord True integer

Начальное значение координат X (в пикселях).

Запуск пикселей Y
StartYCoord True integer

Начальное значение координаты Y (в пикселях).

Конечные пиксели X
EndXCoord True integer

Значение координат x конца (в пикселях).

Конечные пиксели Y
EndYCoord True integer

Значение координаты конца Y (в пикселях).

Количество шагов
NumberOfSteps integer

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

Общее время в секундах
TotalTimeInSeconds double

Общее время, которое должно предпринять действие перемещения от начала до конца.

Максимальное число пикселей смещения
MaximumMovementPixelJitter integer

Максимальное количество пикселей при выполнении действия перетаскивания. Значение 1 или более высокого значения включает смещение. Jitter сглаживается по каждому шагу, чтобы избежать пиков движения. Значение этого входного ввода определяет максимальное число хладеней в любой точке, ограничивающее, насколько далеко мышь может отклониться от пути. Чем выше значение, тем меньше "гладко" будет отображаться действие перетаскивания. Jitter в каждой точке может отклоняться только от предыдущего значения jitter между -2 и 2 (по умолчанию), поэтому максимально возможное jitter равно 2 x NumberOfSteps независимо от того, что вы задаете максимальное значение.

Максимальное число точений пикселя
MaximumEndPixelJitter integer

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

Максимальное разностное смещение пикселей смещения
MaximumMovementPixelJitterDelta integer

При использовании смещения мыши (максимальное число пикселей смещения составляет 1 или выше), максимальное значение жимя в каждой точке может отклоняться от предыдущей точки. Это используется для обеспечения гладкости жимя. Большее значение приводит к меньшей гладкости.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Перемещение относительного указателя мыши

Перемещает мышь в сеансе пользователя агента IA-Connect по указанному количеству пикселей относительно текущей позиции. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Параметры

Имя Ключ Обязательно Тип Описание
X пикселей
XCoord True integer

Количество пикселей X для перемещения мыши, начиная с текущей позиции.

Y пикселей
YCoord True integer

Количество пикселей Y для перемещения мыши, начиная с текущей позиции.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Перенос графического интерфейса агента IA-Connect на передний план

Выводит графический интерфейс агента IA-Connect на передний план, чтобы он был видимым на экране.

Параметры

Имя Ключ Обязательно Тип Описание
Фокус
Focus boolean

Следует ли сосредоточиться на графическом интерфейсе агента IA-Connect?

Глобальный левый щелчок мыши
GlobalLeftMouseClick boolean

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Перетаскивание мыши влево между координатами

Выполняет перетаскивание левой кнопки мыши между двумя указанными координатами в сеансе пользователя агента IA-Connect. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат. Необязательный jitter поддерживается в движении мыши, чтобы сделать его более похожим на движение человеческой руки.

Параметры

Имя Ключ Обязательно Тип Описание
Запуск X пикселей
StartXCoord True integer

Начальное значение координат X (в пикселях).

Запуск пикселей Y
StartYCoord True integer

Начальное значение координаты Y (в пикселях).

Конечные пиксели X
EndXCoord True integer

Значение координат x конца (в пикселях).

Конечные пиксели Y
EndYCoord True integer

Значение координаты конца Y (в пикселях).

Количество шагов
NumberOfSteps integer

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

Общее время в секундах
TotalTimeInSeconds double

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

Максимальное число пикселей смещения
MaximumMovementPixelJitter integer

Максимальное количество пикселей при выполнении действия перетаскивания. Значение 1 или более высокого значения включает смещение. Jitter сглаживается по каждому шагу, чтобы избежать пиков движения. Значение этого входного ввода определяет максимальное число хладеней в любой точке, ограничивающее, насколько далеко мышь может отклониться от пути. Чем выше значение, тем меньше "гладко" будет отображаться действие перетаскивания. Jitter в каждой точке может отклоняться только от предыдущего значения jitter между -2 и 2 (по умолчанию), поэтому максимально возможное jitter равно 2 x NumberOfSteps независимо от того, что вы задаете максимальное значение.

Максимальное число точений пикселя
MaximumEndPixelJitter integer

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

Максимальное разностное смещение пикселей смещения
MaximumMovementPixelJitterDelta integer

При использовании смещения мыши (максимальное число пикселей смещения составляет 1 или выше), максимальное значение жимя в каждой точке может отклоняться от предыдущей точки. Это используется для обеспечения гладкости жимя. Большее значение приводит к меньшей гладкости.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Перетаскивание мыши вправо между координатами

Выполняет перетаскивание правой кнопки мыши между двумя указанными координатами в сеансе пользователя агента IA-Connect. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат. Необязательный jitter поддерживается в движении мыши, чтобы сделать его более похожим на движение человеческой руки.

Параметры

Имя Ключ Обязательно Тип Описание
Запуск X пикселей
StartXCoord True integer

Начальное значение координат X (в пикселях).

Запуск пикселей Y
StartYCoord True integer

Начальное значение координаты Y (в пикселях).

Конечные пиксели X
EndXCoord True integer

Значение координат x конца (в пикселях).

Конечные пиксели Y
EndYCoord True integer

Значение координаты конца Y (в пикселях).

Количество шагов
NumberOfSteps integer

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

Общее время в секундах
TotalTimeInSeconds double

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

Максимальное число пикселей смещения
MaximumMovementPixelJitter integer

Максимальное количество пикселей при выполнении действия перетаскивания. Значение 1 или более высокого значения включает смещение. Jitter сглаживается по каждому шагу, чтобы избежать пиков движения. Значение этого входного ввода определяет максимальное число хладеней в любой точке, ограничивающее, насколько далеко мышь может отклониться от пути. Чем выше значение, тем меньше "гладко" будет отображаться действие перетаскивания. Jitter в каждой точке может отклоняться только от предыдущего значения jitter между -2 и 2 (по умолчанию), поэтому максимально возможное jitter равно 2 x NumberOfSteps независимо от того, что вы задаете максимальное значение.

Максимальное число точений пикселя
MaximumEndPixelJitter integer

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

Максимальное разностное смещение пикселей смещения
MaximumMovementPixelJitterDelta integer

При использовании смещения мыши (максимальное число пикселей смещения составляет 1 или выше), максимальное значение жимя в каждой точке может отклоняться от предыдущей точки. Это используется для обеспечения гладкости жимя. Большее значение приводит к меньшей гладкости.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Перетаскивание средней мыши между координатами

Выполняет перетаскивание средней кнопки мыши между двумя указанными координатами в сеансе пользователя агента IA-Connect. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат. Необязательный jitter поддерживается в движении мыши, чтобы сделать его более похожим на движение человеческой руки.

Параметры

Имя Ключ Обязательно Тип Описание
Запуск X пикселей
StartXCoord True integer

Начальное значение координат X (в пикселях).

Запуск пикселей Y
StartYCoord True integer

Начальное значение координаты Y (в пикселях).

Конечные пиксели X
EndXCoord True integer

Значение координат x конца (в пикселях).

Конечные пиксели Y
EndYCoord True integer

Значение координаты конца Y (в пикселях).

Количество шагов
NumberOfSteps integer

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

Общее время в секундах
TotalTimeInSeconds double

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

Максимальное число пикселей смещения
MaximumMovementPixelJitter integer

Максимальное количество пикселей при выполнении действия перетаскивания. Значение 1 или более высокого значения включает смещение. Jitter сглаживается по каждому шагу, чтобы избежать пиков движения. Значение этого входного ввода определяет максимальное число хладеней в любой точке, ограничивающее, насколько далеко мышь может отклониться от пути. Чем выше значение, тем меньше "гладко" будет отображаться действие перетаскивания. Jitter в каждой точке может отклоняться только от предыдущего значения jitter между -2 и 2 (по умолчанию), поэтому максимально возможное jitter равно 2 x NumberOfSteps независимо от того, что вы задаете максимальное значение.

Максимальное число точений пикселя
MaximumEndPixelJitter integer

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

Максимальное разностное смещение пикселей смещения
MaximumMovementPixelJitterDelta integer

При использовании смещения мыши (максимальное число пикселей смещения составляет 1 или выше), максимальное значение жимя в каждой точке может отклоняться от предыдущей точки. Это используется для обеспечения гладкости жимя. Большее значение приводит к меньшей гладкости.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Поворот колесика мыши

Включает колесико мыши (положительные или отрицательные ночи) в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Поворот колесика
WheelTurns True integer

Число поворотов колесика, выполняемого.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Подключение к сеансу уровня 1 IA-Connect

Присоединяется к IA-Connect сессии директора, получающего сообщения SOAP и /или REST. Это сеанс, в который отправляются команды агенту IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Виртуальный канал должен быть подключен
VirtualChannelMustBeConnected boolean

Должен ли директор IA-Connect проверить, подключен ли виртуальный канал при подключении к сеансу? Это гарантирует, что агент IA-Connect работает в указанном сеансе.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Имя сеанса подключенного уровня 1 IA-Connect
AttachedTier1IAConnectSessionName string

Имя сеанса уровня 1 IA-Connect, к которому был подключен.

Получение буфера обмена

Возвращает текущее содержимое буфера обмена в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Данные буфера обмена
ClipboardData string

Данные, содержащиеся в буфере обмена.

Получение времени простоя IA-Connect директора

Возвращает время работы этого IA-Connect директора в секундах (т. е. продолжительность работы директора).

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Время простоя директора в секундах
UpTimeInSeconds integer

Количество секунд, запущенных директором IA-Connect.

Получение всех задач автоматизации Orchestrator

Извлекает все задачи автоматизации Orchestrator, соответствующие фильтрам.

Параметры

Имя Ключ Обязательно Тип Описание
Фильтр имени службы автоматизации
AutomationName string

Введите значение для получения только задач с этим именем службы автоматизации. Оставьте пустым, чтобы вернуть задачи автоматизации Orchestrator с любым именем (т. е. отключить этот фильтр).

Фильтр состояния задачи автоматизации
AutomationTaskStatus string

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

Фильтрация по запросу свойств
FilterByPropertyQuery string

Фильтрация задач автоматизации с помощью строки запроса. Это идентично входным данным "Фильтр по свойству" в пользовательском интерфейсе задач Orchestrator. Оставьте поле пустым, чтобы не фильтровать по свойству (т. е. отключить этот фильтр). Фильтр поиска должен находиться в формате "значение условия свойства". Поддерживается только один фильтр поиска (нельзя использовать или). Поддерживаемые свойства: name, org, dept, tags, stage, ticketid. Поддерживаемые условия равны, содержат, не равны, а не содержат. Например: Имя равно новым начальным, Имя содержит начальную версию, Организация не равно Acme, Dept содержит продажи.

Минуты до даты отсрочки
MinutesUntilDeferralDate integer

Возвращает только задачи автоматизации Orchestrator, которые готовы выполняться в течение указанного количества минут. Установите значение 0, если вам нужны только задачи автоматизации, готовые к выполнению. Оставьте пустым, если вы хотите получить задачи независимо от отсрочки.

Минимальный уровень приоритета
MinimumPriorityLevel integer

Возвращает только задачи автоматизации Orchestrator, имеющие указанный уровень приоритета или более высокий. Например: параметр 2 вернет задачи с уровнем приоритета 1 и 2.

Сортировка по дате отсрочки
SortByDeferralDate boolean

Задайте значение true, чтобы возвращать данные, отсортированные по дате и времени отсрочки. Задайте значение false, чтобы данные возвращались в том порядке, который он хранит.

Получение задач удержания
RetrieveOnHoldTasks boolean

Если задано значение true (значение по умолчанию для обратной совместимости), задачи будут извлечены, даже если они находятся на удержании. Если задано значение false, при удержании задачи не будут извлечены.

Пропустить
Skip integer

При получении множества сотен результатов можно использовать Skip и MaxResults для получения блока результатов. Пропустить указывает, сколько результатов пропустить, прежде чем возвращать первый элемент в блоке. Параметр Skip to 0 возвращает результаты с начала.

Максимальное количество результатов
MaxResults integer

При получении множества сотен результатов можно использовать Skip и MaxResults для получения блока результатов. MaxResults указывает максимальное количество возвращаемых результатов или 0 для возврата всех результатов после обработки входных данных пропуска.

Исключение данных задачи
ExcludeTaskData boolean

Если задано значение true, свойства данных задачи (TaskData, DeferralStoredData, TaskOutputData) не возвращаются в ответе. Это может значительно уменьшить размер ответа, если у ваших задач есть много сохраненных данных.

Возвращаемое значение

Имя Путь Тип Описание
Задачи автоматизации
AutomationTasks array of object

Набор данных, содержащий все задачи автоматизации Orchestrator, соответствующие заданным критериям поиска. Datatables — это общий формат данных .NET, но сохраняет значения NULL в качестве DbNull. Модуль PowerShell IA-Connect обращается к этому, преобразовав большинство строк DbNull в "". Ответы datetime из Orchestrator будут иметь строковый формат.

items
AutomationTasks object
Количество задач автоматизации
NumberOfAutomationTasks integer

Количество возвращаемых задач автоматизации.

Получение глобальной конфигурации координат агента IA-Connect

Извлекает конфигурацию глобальной системы координат агента IA-Connect, которая используется для отображения расположений элементов (например, во время проверки мыши) и вычисления позиций мыши (например, при выполнении глобальных действий мыши).

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Функции нескольких мониторов
MultiMonitorFunctionality string

Возвращает значение PrimaryMonitor, если агент IA-Connect в настоящее время настроен только для поддержки выделения элементов и выполнения глобальных действий мыши на основном устройстве отображения. Возвращает значение MultiMonitor, если агент IA-Connect будет выделять элементы на всех мониторах (значение по умолчанию с IA-Connect 9.4).

Автоматическое определение умножения проверки мыши
AutoSetMouseInspectionMultiplier boolean

Возвращает значение true, если агент IA-Connect автоматически вычисляет умножение проверки мыши на основном устройстве отображения при запуске агента и каждый раз, когда выполняется проверка мыши (по умолчанию с IA-Connect 9.4). Возвращает значение false, если агент IA-Connect требует, чтобы умножитель проверки мыши был установлен вручную (единственный доступный параметр в IA-Connect 9.3 и более ранних версий). Этот параметр действует только при отключении режима нескольких мониторов.

Автоматическое определение глобального умножения мыши
AutoSetGlobalMouseMultiplier boolean

Возвращает значение true, если агент IA-Connect автоматически вычисляет глобальный умножитель перемещения мыши на основном устройстве отображения при запуске агента и каждый раз, когда выполняется проверка мыши (по умолчанию с IA-Connect 9.4). Возвращает значение false, если агент IA-Connect требует, чтобы глобальный умножитель перемещения мыши был установлен вручную (единственный доступный параметр в IA-Connect 9.3 и более ранних версий). Этот параметр действует только при отключении режима нескольких мониторов.

Мультипликатор проверки мыши X
MouseInspectionXMultiplier double

Текущий умножитель проверки мыши по горизонтали (X) (если агент выделяет то, что находится под мышью). Например, если IA-Connect отображает прямоугольник проверки в половине фактического расположения мыши X, это значение будет равно 0,5. Умножитель действует только в том случае, если функция многоконтрольного монитора отключена, так как умножения вычисляются динамически, когда агент IA-Connect настроен для поддержки нескольких мониторов.

Умножитель проверки мыши Y
MouseInspectionYMultiplier double

Текущий умножитель проверки мыши по вертикали (для того, когда агент выделяет то, что находится под мышью). Например, если IA-Connect отображает прямоугольник проверки в половине фактического расположения мыши Y, это значение будет равно 0,5. Умножитель действует только в том случае, если функция многоконтрольного монитора отключена, так как умножения вычисляются динамически, когда агент IA-Connect настроен для поддержки нескольких мониторов.

Глобальный умножитель мыши X
GlobalMouseXMultiplier double

Текущий глобальный умножитель перемещения мыши по горизонтали (X) (для того, когда агент перемещает мышь). Умножитель действует только в том случае, если функция многоконтрольного монитора отключена, так как умножения вычисляются динамически, когда агент IA-Connect настроен для поддержки нескольких мониторов.

Глобальный умножитель мыши Y
GlobalMouseYMultiplier double

Текущее глобальное умножение перемещения мыши по вертикали (Y) (если агент перемещает мышь). Умножитель действует только в том случае, если функция многоконтрольного монитора отключена, так как умножения вычисляются динамически, когда агент IA-Connect настроен для поддержки нескольких мониторов.

Глобальный метод перемещения мыши
GlobalMouseMoveMethod string

Возвращает текущий глобальный метод перемещения мыши (mouse_event или setcursorpos).

Система координат Java
JavaCoordinateSystem string

Возвращает текущую систему координат Java, которая может быть "Virtual" (по умолчанию) или "Физический" (новая в IA-Connect 9.4). Виртуальные координаты масштабируются, а физические координаты сопоставляются непосредственно с пикселями. Это значение должно быть задано для любой системы координат, представленной мостом доступа Java.

Система координат SAP GUI
SAPGUICoordinateSystem string

Возвращает текущую систему координат API скриптов SAP GUI, которая может быть "Virtual" (по умолчанию) или "Физический" (новая в IA-Connect 9.4). Виртуальные координаты масштабируются, а физические координаты сопоставляются непосредственно с пикселями. Это значение должно быть задано в любой системе координат, представленной API скриптов SAP GUI.

Получение домена компьютера

Возвращает домен компьютера, на котором выполняется сеанс пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Доменное имя
DomainName string

Доменное имя netBIOS компьютера, на котором выполняется сеанс пользователя агента IA-Connect.

DNS-имя домена
DNSDomainName string

Dns-имя домена компьютера, на котором выполняется сеанс пользователя агента IA-Connect.

Получение доступных сеансов IA-Connect

Извлекает список сеансов директора IA-Connect (доступные подключения к сеансам, где выполняется агент IA-Connect, например локальный, Microsoft RDP или Citrix ICA).

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
IA-Connect сеансах JSON
IAConnectSessionsJSON string

Список всех IA-Connect сеансов, отформатированных как JSON.

Количество сеансов IA-Connect
NumberOfIAConnectSessions integer

Общее количество открытых сеансов IA-Connect.

Количество локальных сеансов IA-Connect
NumberOfLocalIAConnectSessions integer

Количество открытых локальных IA-Connect сеансов.

Количество сеансов Citrix ICA IA-Connect
NumberOfCitrixICAIAConnectSessions integer

Количество открытых сеансов Citrix ICA IA-Connect.

Количество сеансов microsoft RDP IA-Connect
NumberOfMicrosoftRDPIAConnectSessions integer

Количество открытых сеансов Microsoft RDP IA-Connect.

Получение журнала агента IA-Connect

Возвращает текущий журнал агента IA-Connect в виде файла или считывая содержимое и возвращая его в выходной переменной.

Параметры

Имя Ключ Обязательно Тип Описание
Сжимать
Compress boolean

Следует ли сжимать исполняемый файл агента IA-Connect во время отправки?

Возврат только журналов последней команды
ReturnLastCommandOnly boolean

Должен ли журнал агента IA-Connect быть ограничен результатом последней команды, а не всем журналом?

Сохранение журнала в файл
SaveLogToFile boolean

Следует ли сохранить журнал агента IA-Connect в виде файла?

Размещение содержимого журнала в элементе данных
PlaceLogContentInDataItem boolean

Следует ли возвращать содержимое журнала в выходной переменной?

Локальная папка сохранения
LocalSaveFolder string

Файловый путь к папке для сохранения входа агента IA-Connect.

Использование имени файла журнала агента
UseAgentLogFilename boolean

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

Имя файла локального сохранения
LocalSaveFilename string

Имя файла только локального файла сохранения для журнала агента IA-Connect. Это будет использоваться только в том случае, если для имени файла журнала агента задано значение false.

Максимальное число байтов для чтения
MaxBytesToRead integer

Максимальное количество байтов для чтения из журнала агента (от конца назад). Для получения всего журнала можно задать значение 0 или -1.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Содержимое журнала агента
IAConnectAgentLogContentsBase64 string

Содержимое журнала агента IA-Connect.

Имя файла журнала локального сохранения
IAConnectAgentLogFilenameOnly string

Путь к сохраненной имени файла журнала.

Получение журнала входа из Orchestrator

Возвращает журнал входа в IA-Connect Orchestrator для создания отчетов. При необходимости можно использовать один или несколько фильтров, чтобы ограничить возвращаемые результаты.

Параметры

Имя Ключ Обязательно Тип Описание
В течение последнего числа дней
WithinLastNumberOfDays integer

Отфильтруйте результаты, чтобы получить только имена входа Orchestrator в течение указанного количества дней. Установите значение 0, чтобы не фильтровать.

Адрес электронной почты
SearchByEmail string

Отфильтруйте результаты, чтобы получить только имена входа Orchestrator с указанным адресом электронной почты. Установите значение "Пустой", чтобы не фильтровать по адресу электронной почты.

Окно запуска журнала входа
SearchLoginHistoryTimeStartWindow date-time

Отфильтруйте результаты, чтобы получить только имена входа Orchestrator после указанного времени начала. Установите значение "Пустой", чтобы не фильтровать. Например: "2022-01-24T07:00:00" вернет все имена входа Orchestrator в 24 января 2022 года или после 07,00 часов. Все даты и времени находятся в формате UTC (GMT+0), поэтому вы можете использовать действие Convert DateTime для преобразования локального времени в UTC.

Окно окончания журнала входа
SearchLoginHistoryTimeEndWindow date-time

Отфильтруйте результаты, чтобы получить только имена входа Orchestrator до указанного времени начала. Установите значение "Пустой", чтобы не фильтровать. Например: "2022-01-25T07:00:00" вернет все имена входа Orchestrator в 25 января 2022 г. или до 25.00 часов. Все даты и времени находятся в формате UTC (GMT+0), поэтому вы можете использовать действие Convert DateTime для преобразования локального времени в UTC.

Возвращаемое значение

Имя Путь Тип Описание
Json журнала входа Orchestrator
OrchestratorLoginHistoryJSON string

Список всех имен входа Orchestrator в соответствии с указанными фильтрами в формате JSON.

Количество имен входа Orchestrator
NumberOfOrchestratorLogins integer

Число возвращенных имен входа Orchestrator.

Получение задачи автоматизации Orchestrator

Извлекает определенную задачу автоматизации Orchestrator.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор задачи
TaskId True integer

Идентификатор задачи Orchestrator, которую требуется получить.

Изменение состояния на
StatusChange string

Если задано значение "Извлечено": при получении задачи состояние задачи изменится на "Извлечено", чтобы запретить другим действиям пытаться выполнить ту же задачу. Если задано значение "Не делать ничего", состояние задачи не изменится.

Возвращаемое значение

Имя Путь Тип Описание
Имя службы автоматизации
AutomationName string

Имя полученной задачи Orchestrator.

Идентификатор операции
OperationId string

Идентификатор операции полученной задачи Orchestrator. Этот идентификатор операции (или идентификатор задачи) можно использовать для получения задачи на более позднюю дату. Идентификатор операции является уникальной, неуправляемой строкой, ограничивающей возможность для 3-й стороны угадать идентификатор операции, которая они не создали.

Дата и время отсрочки
DeferralDateTime string

Дата и время, когда извлекаемая задача Orchestrator должна быть готова. Эта строка будет возвращена в формате UTC.

Отсрочка хранимых данных
DeferralStoredData string

Необязательные данные, хранящиеся при отложении задачи. Обычно это данные, которые необходимо продолжить процесс или поток.

Количество отложений
DeferralCount integer

Как часто эта задача была отложена. Обычно это будет 0 для новой задачи, которая никогда не была отложена или 1 или более для отложенной задачи. Каждый раз, когда отложенная задача была отложена снова, оркестратор автоматически увеличит это число.

Входные данные задачи
TaskInputData string

Необязательные данные, хранящиеся при создании задачи. Обычно это данные, которые использовались для запуска процесса или потока, но это поле можно использовать для любой цели. Это можно отформатировать как любой текстовый формат выбранного текста, например JSON или XML или необработанный текст.

Выходные данные задачи
TaskOutputData string

Необязательные данные, сохраненные автоматизацией при обработке задачи. Это можно отформатировать как любой текстовый формат выбранного текста, например JSON или XML или необработанный текст.

Priority
Priority integer

Уровень приоритета этой задачи Orchestrator (1 — самый высокий).

Состояние задачи автоматизации
AutomationTaskStatus string

Состояние полученной задачи Orchestrator.

Этап процесса
ProcessStage string

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

Дата и время получения
ReceivedDateTime string

Дата и время первоначальной получения задачи оркестратором. Эта строка будет возвращена в формате UTC.

Минуты до даты отсрочки
MinutesUntilDeferralDate integer

Количество минут до даты отсрочки этой задачи (т. е. когда эта задача готова к выполнению). Если эта задача готова к выполнению минут, будет равно 0.

Ожидание
OnHold boolean

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

Имя типа источника
SourceTypeName string

Имя источника задачи. Веб-интерфейс представляет задачу вручную, введенную через пользовательский интерфейс. REST API представляет задачу, созданную с помощью REST API Оркестратора. ServiceNow представляет задачу, созданную из внутренней интеграции ServiceNow Orchestrator.

Понятное имя источника
SourceFriendlyName string

Если задача была создана из внутренней интеграции Orchestrator "Источники" (например, ServiceNow), она содержит понятное имя этого источника.

Исходный идентификатор билета
SourceTicketId string

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

Исходный идентификатор дочернего билета
SourceTicketSubId string

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

Организация
Organisation string

Эта задача связана с организацией. Обычно используется для поиска и фильтрации задач.

Отдел
Department string

Эта задача связана с отделом. Обычно используется для поиска и фильтрации задач.

Description
Description string

Описание этой задачи. Обычно используется для поиска и фильтрации задач.

Метки
Tags string

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

Получение имени компьютера

Возвращает имя компьютера, на котором выполняется сеанс пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Имя машины
MachineName string

Имя компьютера, на котором выполняется сеанс пользователя агента IA-Connect.

Получение имени узла клиента

Возвращает имя узла клиента, на котором выполняется директор IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Имя узла клиента
ClientHostname string

Имя узла клиента, на котором выполняется директор IA-Connect.

Получение количества процессов агента IA-Connect

Возвращает количество экземпляров агента IA-Connect, работающего в настоящее время в сеансе пользователя. Это полезно для обнаружения наличия нескольких экземпляров запущенного агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Количество процессов
NumberOfProcesses integer

Количество процессов агента IA-Connect, которые в настоящее время выполняются в сеансе пользователя.

Получение количества процессов по имени

Возвращает количество выполняемых процессов в сеансе пользователя агента IA-Connect с указанным именем процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Имя процесса
ProcessName True string

Имя процесса.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Количество процессов
NumberOfProcesses integer

Количество процессов, соответствующих указанному имени процесса.

Получение метода перемещения мыши

Возвращает текущий метод перемещения мыши.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Метод перемещения мыши
MouseMoveMethod string

Возвращает текущий метод перемещения мыши (mouse_event или setcursorpos).

Получение операции автоматизации Orchestrator

Извлекает определенную задачу автоматизации Orchestrator, указав уникальный идентификатор операции задачи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор операции
OperationId True string

Идентификатор операции задачи Orchestrator, которую требуется получить.

Возвращаемое значение

Имя Путь Тип Описание
Имя службы автоматизации
AutomationName string

Имя полученной задачи Orchestrator.

Дата и время отсрочки
DeferralDateTime string

Дата и время, когда извлекаемая задача Orchestrator должна быть готова. Эта строка будет возвращена в формате UTC.

Отсрочка хранимых данных
DeferralStoredData string

Необязательные данные, хранящиеся при отложении задачи. Обычно это данные, которые необходимо продолжить процесс или поток.

Количество отложений
DeferralCount integer

Как часто эта задача была отложена. Обычно это будет 0 для новой задачи, которая никогда не была отложена или 1 или более для отложенной задачи. Каждый раз, когда отложенная задача была отложена снова, оркестратор автоматически увеличит это число.

Входные данные задачи
TaskInputData string

Необязательные данные, хранящиеся при создании задачи. Обычно это данные, которые использовались для запуска процесса или потока, но это поле можно использовать для любой цели. Это можно отформатировать как любой текстовый формат выбранного текста, например JSON или XML или необработанный текст.

Выходные данные задачи
TaskOutputData string

Необязательные данные, сохраненные автоматизацией при обработке задачи. Это можно отформатировать как любой текстовый формат выбранного текста, например JSON или XML или необработанный текст.

Priority
Priority integer

Уровень приоритета этой задачи Orchestrator (1 — самый высокий).

Состояние задачи автоматизации
AutomationTaskStatus string

Состояние полученной задачи Orchestrator.

Этап процесса
ProcessStage string

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

Дата и время получения
ReceivedDateTime string

Дата и время первоначальной получения задачи оркестратором. Эта строка будет возвращена в формате UTC.

Минуты до даты отсрочки
MinutesUntilDeferralDate integer

Количество минут до даты отсрочки этой задачи (т. е. когда эта задача готова к выполнению). Если эта задача готова к выполнению минут, будет равно 0.

Ожидание
OnHold boolean

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

Организация
Organisation string

Эта задача связана с организацией. Обычно используется для поиска и фильтрации задач.

Отдел
Department string

Эта задача связана с отделом. Обычно используется для поиска и фильтрации задач.

Description
Description string

Описание этой задачи. Обычно используется для поиска и фильтрации задач.

Метки
Tags string

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

Получение папок

Возвращает все вложенные папки в указанной папке на компьютере, где запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к каталогу
DirectoryPath True string

Полный путь к каталогу (папке). Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Папки JSON
FoldersJSON string

Список вложенных папок, содержащихся в папке в формате JSON.

Количество папок, которые успешно считываются
NumberOfFoldersReadSuccessfully integer

Количество вложенных папок, которые были успешно прочитаны.

Количество папок, которые не удалось прочитать
NumberOfFoldersFailedToRead integer

Количество вложенных папок, которые не удалось прочитать.

Получение последнего неудачного действия из статистики потока Orchestrator

Извлекает сведения о последнем действии, передавшемуся через IA-Connect Orchestrator рабочей роли, если это действие завершилось сбоем. Это действие чаще всего используется во время обработки ошибок.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Рабочая роль, выделенная для выполнения потока
WorkerAllocatedToFlowRun boolean

Возвращает значение true, если в этом потоке выделен рабочий объект, поэтому можно указать сведения об ошибке последнего действия. Возвращает значение false, если для выполнения этого потока не выделена рабочая роль (либо она никогда не была выделена, либо рабочая роль теперь была доступна для другого запуска потока) и поэтому не может быть предоставлена информация о последней ошибке.

Последнее действие завершилось сбоем
LastActionFailed boolean

Возвращает значение true, если последнее действие в этом потоке выполнения (которое выполняется на рабочей роли, выделенной для этого потока), завершилось сбоем: другие выходные данные из этого действия будут содержать сведения. Возвращает значение false, если последнее действие в этом потоке не завершилось ошибкой: другие выходные данные будут пустыми.

Последний путь запроса на неудачное действие
LastFailedActionRequestPath string

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

Последнее сообщение об ошибке действия
LastFailedActionErrorMessage string

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

Получение последних входных данных

Возвращает время после получения последнего ввода пользователем в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Последние секунды ввода
LastInputTotalSeconds integer

Количество секунд, прошедших с момента последнего ввода.

Последние минуты ввода
LastInputTotalMinutes integer

Количество минут, прошедших с момента последнего ввода.

Последние входные часы
LastInputTotalHours integer

Количество часов, прошедших с момента последнего ввода.

Получение потоков агента

Возвращает список потоков агента. Поток агента можно использовать для выполнения определенных действий в потоке, что позволяет выполнять действия в течение длительного времени (дольше времени ожидания RPA) или выполняться параллельно с другими действиями. Как правило, после завершения работы потока агента и получения его данных поток агента удаляется и не будет отображаться в списке потоков.

Параметры

Имя Ключ Обязательно Тип Описание
Порядок сортировки
SortOrder string

Порядок сортировки для выходного списка потоков агента. Поддерживаемые заказы сортировки: None, ThreadStartTime, ThreadStartTime_Desc, ThreadEndTime, ThreadEndTime_Desc, ThreadId, ThreadId_Desc, ThreadActionName, ThreadActionName_Desc, ThreadRuntime, ThreadRuntime_Desc.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Число потоков агента
NumberOfAgentThreads integer

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

Потоки агента
AgentThreads array of object

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

ThreadId
AgentThreads.ThreadId integer
IAConnectActionName
AgentThreads.IAConnectActionName string
ThreadStartDateTimeUTC
AgentThreads.ThreadStartDateTimeUTC date-time
ThreadCompletedDateTimeUTC
AgentThreads.ThreadCompletedDateTimeUTC date-time
ThreadRuntimeInSeconds
AgentThreads.ThreadRuntimeInSeconds integer
ThreadStarted
AgentThreads.ThreadStarted boolean
ThreadRunning
AgentThreads.ThreadRunning boolean
ThreadCompleted
AgentThreads.ThreadCompleted boolean
ThreadSuccess
AgentThreads.ThreadSuccess boolean
ThreadStatusMessage
AgentThreads.ThreadStatusMessage string
ThreadErrorMessage
AgentThreads.ThreadErrorMessage string

Получение принтера по умолчанию

Возвращает имя принтера по умолчанию для пользователя в сеансе агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Имя принтера по умолчанию
DefaultPrinterName string

Имя принтера по умолчанию для пользователя.

Получение процесса по идентификатору процесса

Возвращает, выполняется ли процесс с указанным идентификатором процесса в сеансе пользователя агента IA-Connect. Идентификаторы процессов уникальны, поэтому только один процесс может соответствовать идентификатору. Идентификаторы процесса являются динамическими и отличаются для каждого запуска приложения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
ProcessId True integer

Идентификатор процесса для получения.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Выполнение процесса
ProcessRunning boolean

Возвращает значение true, если был найден процесс с предоставленным идентификатором процесса.

Получение процессов

Возвращает список выполняемых процессов в сеансе пользователя агента IA-Connect. При необходимости это можно отфильтровать, указав имя процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Имя процесса
ProcessName string

Необязательный фильтр для имени процесса.

Получение командной строки процесса
GetProcessCommandLine boolean

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Количество процессов
NumberOfProcesses integer

Количество процессов, выполняемых в сеансе пользователя.

Обработка JSON
ProcessesJSON string

Список процессов, выполняемых в сеансе пользователя в формате JSON.

Получение рабочей роли Orchestrator

Получение сведений и динамического состояния отдельной рабочей роли, зарегистрированной в IA-Connect Orchestrator.

Параметры

Имя Ключ Обязательно Тип Описание
Поиск идентификатора рабочей роли
SearchWorkerId integer

Идентификатор извлекаемой рабочей роли. Задайте значение 1 или выше, чтобы получить сведения о рабочей роли с указанным идентификатором. Установите значение 0, если вы не хотите получить рабочую роль по идентификатору.

Поиск имени рабочей роли
SearchWorkerName string

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

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор рабочей роли
WorkerId integer

Внутренний идентификатор оркестратора для этой рабочей роли.

Имя рабочей роли
WorkerName string

Внутреннее имя оркестратора для этой рабочей роли.

Описание рабочей роли
WorkerDescription string

Описание внутреннего оркестратора для этой рабочей роли.

Отображаемое имя текущего потока
CurrentFlowDisplayName string

Отображаемое имя потока, обрабатываемого этим рабочим процессом, или пустое, если рабочий процесс неактивен.

Состояние реального времени рабочей роли
LiveStatus boolean

Значение true, если рабочий элемент в настоящее время подключен к Оркестратору и отвечает на опросы. Значение false, если рабочая роль не подключена.

Последние галочки контакта
LiveStatusLastContactTicks integer

Время, в галках, когда оркестратор последний раз связался с работником. Это число 100-наносекунд интервалов, прошедших с 12:00:00 полуночи, 1 января 0001 года UTC. Это общий, универсальный формат времени.

Секунды с последнего контакта
SecondsSinceLastContact integer

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

Рабочая роль в режиме обслуживания
MaintenanceMode boolean

Значение true, если рабочий объект в настоящее время находится в режиме обслуживания. Значение false, если рабочая роль не находится в режиме обслуживания.

Приоритет рабочей роли
Priority integer

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

Время ожидания рабочей роли в секундах
TimeoutInSeconds integer

Как долго в секундах оркестратор должен ожидать ответа REST API от директора IA-Connect перед истечением времени ожидания.

Рабочая роль лицензирована
AgentIsLicensed boolean

Значение true, если в настоящее время рабочая роль лицензирована. Значение false, если рабочая роль не лицензирована. Значение NULL, если оркестратор не знает, лицензируется ли рабочий сотрудник (может не отвечать, может быть очень старым агентом, который не предоставляет обновления динамического лицензирования в опросе).

Функции лицензии агента
AgentLicenseFeatures string

Специальные функции лицензии агента. Например, JML для joiner, Mover, оставить лицензию.

Рабочая роль доступна для работы
IsAvailableForWork boolean

Значение true, если работник доступен для работы, то это означает, что работник может принять входящие трудоемкие данные. Значение false, если рабочий элемент не является. Доступно для работы определяется параметром a) Является ли рабочий статус динамическим, б) Является работником в режиме обслуживания, c) Является ли рабочий лицензированный, d) Является работником, который в настоящее время обрабатывает поток.

Идентификатор типа подключения рабочей роли
WorkerConnectionTypeId integer

Идентификатор настроенного типа подключения рабочей роли, используемый для подключения рабочей роли к Orchestrator. Это может быть 1 для "Ретранслятора WCF Azure", 2 для "Гибридное подключение Azure", 3 для "Виртуальная сеть Azure", 4 для Direct.

Имя типа рабочего подключения
WorkerConnectionTypeName string

Имя настроенного типа подключения рабочей роли, используемого для подключения рабочей роли к Orchestrator. Это может быть AzureWCFRelay, AzureHybridConnection, AzureVNet, Direct.

URL-адрес REST API директора
DirectorRestApiUrl string

Если настроенный тип подключения — гибридные подключения, виртуальная сеть или прямая, это свойство содержит URL-адрес REST API рабочей роли, который обычно является HTTP-трафиком, так как HTTP-трафик шифруется внутри туннеля HTTPS (например, гибридное подключение или локальный шлюз данных). Если настроенный тип подключения — ретранслятор WCF Azure, это свойство содержит URL-адрес ретранслятора WCF.

Пространство имен Служебной шины Azure
AzureServiceBusNamespace string

Если настроенный тип подключения — Azure WCF Relay, он содержит пространство имен служебной шины Azure.

Имя ретранслятора WCF Azure
AzureWCFRelayName string

Если настроен тип подключения — Azure WCF Relay, это свойство содержит имя ретранслятора WCF Azure.

Имя типа подключения агента
IAConnectAgentConnectionTypeName string

Имя типа подключения агента. Это может быть локальный агент, Citrix ICA или Microsoft RDP.

Присоединен к директору следующего прыжка
AttachedToNextHopDirector boolean

Если директор, подключенный к Оркестратору (обычно директор, размещенный локальным агентом), перенаправит действия в директор следующего прыжка (обычно Citrix ICA или директор Microsoft RDP), это свойство будет иметь значение True. Если директор отправляет действия непосредственно агенту, к которому он подключен (обычно локальный агент), это свойство будет иметь значение False.

Тип сеанса директора следующего прыжка
NextHopDirectorSessionType string

Если директор, подключенный к оркестратору (обычно директор, размещенный локальным агентом), перенаправит действия в директор следующего прыжка (обычно Citrix ICA или директор Microsoft RDP), это свойство будет содержать имя типа подключения, который будет иметь имя типа подключения, который будет иметь значение Citrix ICA или Microsoft RDP.

Версия директора
DirectorVersion string

Внутренняя версия директора IA-Connect, которая обрабатывает интерфейс REST API и предоставляет инспектор IA-Connect для агента IA-Connect, работающего в рабочей роли IA-Connect.

Версия агента
AgentVersion string

Внутренняя версия агента IA-Connect, которая выполняется в рабочей роли IA-Connect.

Версия выпуска директора
DirectorReleaseVersion double

Версия IA-Connect выпуска директора IA-Connect, которая обрабатывает интерфейс REST API и предоставляет инспектор IA-Connect для агента IA-Connect, работающего в рабочей роли IA-Connect.

Версия выпуска агента
AgentReleaseVersion double

Версия IA-Connect агента IA-Connect, которая выполняется в рабочей роли IA-Connect.

Имя узла директора
DirectorHostname string

Имя узла операционной системы, в которой размещается директор IA-Connect. Это имя узла рабочей роли, которое обычно совпадает с именем рабочей роли.

Доменное имя директора NETBIOS
DirectorNetBIOSDomainName string

Доменное имя NETBIOS операционной системы, в которой размещается директор IA-Connect, который является компонентом агента IA-Connect, работающего на рабочей роли IA-Connect. Для рабочей группы это обычно имя узла рабочей роли. Для домена Active Directory это доменное имя NetBIOS. Например, MYDOMAIN.

Доменное имя директора DNS
DirectorDNSDomainName string

Dns-имя домена операционной системы, в которой размещается директор IA-Connect, который является компонентом агента IA-Connect, работающего на рабочей роли IA-Connect. Для рабочей группы обычно это пусто. Для домена Active Directory это DNS-имя домена. Например, mydomain.local.

Количество поддерживаемых идентификаторов среды потока
SupportedFlowEnvironmentIdsCount integer

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

Количество поддерживаемых имен потоков
SupportedFlowNamesCount integer

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

Число неподдерживаемых имен потоков
UnsupportedFlowNamesCount integer

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

Число рабочих тегов
WorkerTagsCount integer

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

Количество обязательных тегов рабочей роли
WorkerMandatoryTagsCount integer

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

Получение размера файла

Возвращает размер файла (в байтах) на компьютере, где выполняется агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу
Filename True string

Полный путь к файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Размер файла
FileSize integer

Размер файла в байтах.

Получение разрешений безопасности папок

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

Параметры

Имя Ключ Обязательно Тип Описание
Путь к папке
FolderPath True string

Полный путь к папке. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Разрешения безопасности JSON
SecurityPermissionsJSON string

Разрешения, заданные в настоящее время в указанной папке в формате JSON.

Получение разрешений на безопасность файлов

Возвращает список разрешений, установленных в данный момент на файле на компьютере, где запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу
FilePath True string

Полный путь к файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Разрешения безопасности JSON
SecurityPermissionsJSON string

Разрешения, заданные в данный момент в указанном файле в формате JSON.

Получение разрешения экрана

Возвращает разрешение экрана сеанса пользователя агента IA-Connect. Для IA-Connect локального агента, работающего на физическом рабочем столе или ноутбуке, вы получите сведения обо всех устройствах отображения и их масштабировании. На виртуальной машине обычно сообщается только один дисплей, если виртуальная машина не настроена для представления нескольких дисплеев (редко). В удаленном сеансе обычно сообщается только один дисплей, даже если отображение охватывает несколько локальных дисплеев, так как удаленные сеансы обычно создают один виртуальный дисплей.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Горизонтальное разрешение
HorizontalResolution integer

Горизонтальное физическое разрешение первичного экрана. Физические координаты сопоставляют непосредственно с пикселями на мониторе.

Вертикальное разрешение
VerticalResolution integer

Вертикальное физическое разрешение первичного экрана. Физические координаты сопоставляют непосредственно с пикселями на мониторе.

Количество экранов
NumberOfScreens integer

Количество экранов в этом сеансе.

Горизонтальное разрешение второго отображения
SecondDisplayHorizontalResolution integer

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

Второе разрешение по вертикали отображения
SecondDisplayVerticalResolution integer

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

Горизонтальное разрешение третьего дисплея
ThirdDisplayHorizontalResolution integer

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

Третье разрешение по вертикали отображения
ThirdDisplayVerticalResolution integer

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

Горизонтальное разрешение на четвертое отображение
FourthDisplayHorizontalResolution integer

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

Четвертое разрешение по вертикали отображения
FourthDisplayVerticalResolution integer

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

Пиксели левого края виртуального экрана
VirtualScreenLeftEdgePixels integer

Левый край всего виртуального дисплея (все обнаруженные отображения). Виртуальные координаты масштабируются.

Пиксели верхнего края виртуального экрана
VirtualScreenTopEdgePixels integer

Верхний край всего виртуального дисплея (все обнаруженные отображения). Виртуальные координаты масштабируются.

Пиксели ширины виртуального экрана
VirtualScreenWidthPixels integer

Ширина всего виртуального дисплея (все обнаруженные отображения). Виртуальные координаты масштабируются.

Пиксели высоты виртуального экрана
VirtualScreenHeightPixels integer

Высота всего виртуального дисплея (все обнаруженные отображения). Виртуальные координаты масштабируются.

Масштабирование основного дисплея
PrimaryDisplayScaling double

Умножение масштабирования DPI первичного отображения в виде десятичного значения. Например, 100% будут возвращены как 1.0 и 125% будут возвращены как 1,25.

Масштабирование второго дисплея
SecondDisplayScaling double

Умножитель масштабирования DPI второго отображения в виде десятичного значения. Например, 100% будут возвращены как 1.0 и 125% будут возвращены как 1,25.

Масштабирование третьего дисплея
ThirdDisplayScaling double

Умножение масштабирования DPI третьего отображения в виде десятичного значения. Например, 100% будут возвращены как 1.0 и 125% будут возвращены как 1,25.

Масштабирование четвертого дисплея
FourthDisplayScaling double

Коэффициент масштабирования DPI для четвертого дисплея в виде десятичного значения. Например, 100% будут возвращены как 1.0 и 125% будут возвращены как 1,25.

Физический экран слева от края пикселей
PhysicalScreenLeftEdgePixels integer

Левый край всего физического дисплея (все обнаруженные отображения). Физические координаты сопоставляют непосредственно с пикселями на мониторе.

Физический экран верхнего края пикселей
PhysicalScreenTopEdgePixels integer

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

Пиксели ширины физического экрана
PhysicalScreenWidthPixels integer

Ширина всего физического дисплея (все обнаруженные отображения). Физические координаты сопоставляют непосредственно с пикселями на мониторе.

Физические пиксели высоты экрана
PhysicalScreenHeightPixels integer

Высота всего физического дисплея (все обнаруженные отображения). Физические координаты сопоставляют непосредственно с пикселями на мониторе.

Основной экран левого края пикселей
PrimaryDisplayLeftEdgePixels integer

Левый физический край первичного дисплея. Физические координаты сопоставляют непосредственно с пикселями на мониторе.

Основной экран верхнего края пикселей
PrimaryDisplayTopEdgePixels integer

Верхний физический край первичного дисплея. Физические координаты сопоставляют непосредственно с пикселями на мониторе.

Второй экран левого края пикселей
SecondDisplayLeftEdgePixels integer

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

Второе отображение верхних краев пикселей
SecondDisplayTopEdgePixels integer

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

Третье отображение левого края пикселей
ThirdDisplayLeftEdgePixels integer

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

Третий дисплей верхнего края пикселей
ThirdDisplayTopEdgePixels integer

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

Четвертый отображаемый левый край пикселей
FourthDisplayLeftEdgePixels integer

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

Четвертое отображение верхнего края пикселей
FourthDisplayTopEdgePixels integer

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

Получение родительского идентификатора процесса

Возвращает идентификатор процесса родительского процесса для любого выполняемого процесса в сеансе пользователя агента IA-Connect с указанным идентификатором процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
ProcessId True integer

Идентификатор процесса дочернего процесса.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор родительского процесса
ParentProcessId integer

Идентификатор процесса родительского процесса.

Родительский процесс по-прежнему выполняется
ParentProcessStillRunning boolean

Возвращает значение true, если родительский процесс по-прежнему запущен и не завершен.

Имя родительского процесса
ParentProcessName string

Имя процесса родительского процесса.

Получение сведений о директоре IA-Connect

Возвращает свойства IA-Connect директора, включая номер версии и путь к исполняемому файлу директора.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
версия директора IA-Connect
IAConnectDirectorVersion string

Полный номер версии директора IA-Connect.

Версия DotNet CLR
DotNetCLRVersion string

Версия clR (DotNet Common Language Runtime).

IA-Connect директор запускается в качестве имени пользователя
IAConnectDirectorRunAsUsername string

Имя пользователя сеанса, в котором работает директор IA-Connect.

IA-Connect Директор работает в качестве пользовательского домена
IAConnectDirectorRunAsUserdomain string

Домен пользователя сеанса пользователя, в котором работает директор IA-Connect.

Путь к директору IA-Connect
IAConnectDirectorPath string

Полный путь к исполняемому файлу IA-Connect Директора.

IA-Connect директор — это 64-разрядный процесс
IAConnectDirectorIs64bitProcess boolean

Возвращает значение true, если директор IA-Connect является 64-разрядным процессом или значением false, если нет.

версия выпуска IA-Connect директора
IAConnectDirectorReleaseVersion string

Версия выпуска IA-Connect директора, например 8.0.

имя файла журнала IA-Connect директора
IAConnectDirectorLogFilename string

Имя файла журнала IA-Connect директора. Это значение уникально для каждого запуска IA-Connect директора, так как он имеет дату и время запуска в имени файла.

Получение сведений о сеансе агента IA-Connect

Возвращает сведения о сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
ИД сеанса
SessionId integer

Текущий идентификатор сеанса удаленного пользователя.

Тип сеанса
SessionType integer

Тип удаленного сеанса( 1 (Citrix), 2 (RDP) или 0 (консоль).

Имя типа сеанса
SessionTypeName string

Тип удаленного сеанса( ICA (Citrix), RDP или Console.

Получение сведений о среде

Возвращает сведения о среде, в которой выполняется сеанс пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Основная версия ОС
OSVersionMajor integer

Основная версия операционной системы.

Дополнительная версия ОС
OSVersionMinor integer

Дополнительная версия операционной системы.

Версия сборки ОС
OSVersionBuild integer

Версия сборки операционной системы.

ОС составляет 64 бит
OSIs64Bit boolean

Возвращает значение true, если операционная система составляет 64 бит.

Число процессоров
ProcessorCount integer

Число процессоров.

Общая физическая память в МБ
TotalPhysicalRAMInMB integer

Объем физической ОЗУ (в МБ).

Общий объем виртуальной оперативной памяти в МБ
TotalVirtualRAMInMB integer

Объем виртуальной ОЗУ (в МБ).

Доступный физический ОЗУ в МБ
AvailablePhysicalRAMInMB integer

Объем физической оперативной памяти, доступной в данный момент (в МБ).

Доступные виртуальные ОЗУ в МБ
AvailableVirtualRAMInMB integer

Объем виртуальной оперативной памяти, доступной в настоящее время (в МБ).

Полное имя ОС
OSFullName string

Полное имя операционной системы, например Microsoft Windows Server 2019 Standard.

Установленное имя языка и региональных параметров пользовательского интерфейса
InstalledUICultureName string

Язык пользовательского интерфейса, установленный с операционной системой, например en-US.

Текущее имя языка и региональных параметров пользовательского интерфейса
CurrentUICultureName string

Язык пользовательского интерфейса по умолчанию, например en-US.

Текущее имя языка и региональных параметров
CurrentCultureName string

Языковой стандарт пользователя по умолчанию, например en-GB.

Получение сведений о типе клиента и сеансе директора

Возвращает сведения о локальном или удаленном сеансе, обрабатываемом директором уровня 1.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Тип удаленного клиента
RemoteClientType string

Удаленный тип клиента ("Локальный", "Citrix ICA" или "Microsoft RDP").

Подключенный виртуальный канал
VirtualChannelConnected boolean

Значение true, если виртуальный канал подключен, между директором и агентом.

Версия директора
DirectorVersion string

Версия библиотеки DLL IA-Connect директора. Например: 1.67.21.0.

Версия выпуска директора
DirectorReleaseVersion string

Версия IA-Connect выпуска директора IA-Connect. Например: 9.4.

Версия агента
AgentVersion string

Версия EXE агента IA-Connect, к которому подключен этот директор. Например: 1.74.21.0.

Версия выпуска агента
AgentReleaseVersion string

Версия IA-Connect выпуска агента IA-Connect, к которому подключен этот директор. Например: 9.4.

Агент лицензирован
AgentIsLicensed boolean

Значение true, если агент IA-Connect, к которому подключен этот директор, лицензирован. Значение false, если агент IA-Connect не лицензирован. Значение NULL, если состояние лицензии агента неизвестно.

Функции лицензии агента
AgentLicenseFeatures string

Разделенный запятыми список функций лицензии IA-Connect, назначенных агенту IA-Connect, к которому подключен этот директор. Например, JML, DEV.

Имя узла директора
DirectorHostname string

Имя узла компьютера, на котором работает директор. Например: vmrpa1.

Доменное имя директора NetBIOS
DirectorNetBIOSDomainName string

Доменное имя netBIOS компьютера, на котором работает директор. Например: domain1. Если компьютер не является членом домена, обычно возвращает имя узла.

Доменное имя директора DNS
DirectorDNSDomainName string

DNS-имя домена компьютера, на котором работает директор. Например: domain1.myorg.local. Если компьютер не является членом домена, обычно возвращает имя узла.

Присоединен к директору следующего прыжка
AttachedToNextHopDirector boolean

Установите значение false, если сеанс IA-Connect в настоящее время подключен к агенту, к которому подключен этот директор. Установите значение true, если директор перенаправляет все действия (т. е. присоединен) другому директору (который подключен к другому агенту). Например, если этот директор является локальным директором, взаимодействующим с локальным агентом, но сеанс IA-Connect в настоящее время присоединен к Citrix, это значение будет true.

Тип сеанса директора следующего прыжка
NextHopDirectorSessionType string

Если этот директор присоединен к директору следующего прыжка, это значение будет содержать тип сеанса следующего прыжка. Например, если этот директор является локальным директором, взаимодействующим с локальным агентом, но сеанс IA-Connect в настоящее время присоединен к Citrix, это значение будет "Citrix ICA", тогда как значение "Удаленный тип клиента" будет "Локальный" (представляющее локальный директор пересылки действий в Citrix).

Получение сведений об агенте IA-Connect

Возвращает свойства агента IA-Connect, включая номер версии и путь к исполняемому файлу агента.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
версия агента IA-Connect
IAConnectAgentVersion string

Полный номер версии агента IA-Connect.

Версия DotNet CLR
DotNetCLRVersion string

Версия clR (DotNet Common Language Runtime).

агент IA-Connect запуска от имени пользователя
IAConnectAgentRunAsUsername string

Имя пользователя сеанса, в котором запущен агент IA-Connect.

агент IA-Connect запуска от имени пользователя
IAConnectAgentRunAsUserdomain string

Домен пользователя сеанса пользователя, в котором запущен агент IA-Connect.

Путь агента IA-Connect
IAConnectAgentPath string

Полный путь к исполняемому файлу агента IA-Connect.

агент IA-Connect — 64-разрядный процесс
IAConnectAgentIs64bitProcess boolean

Возвращает значение true, если агент IA-Connect является 64-разрядным процессом или значением false, если нет.

версия выпуска агента IA-Connect
IAConnectAgentReleaseVersion string

Версия выпуска агента IA-Connect, например 8.0.

время ожидания команды RPA агента IA-Connect
IAConnectAgentRPACommandTimeout integer

Время ожидания команды RPA агента IA-Connect. Это значение по умолчанию — 30 секунд и можно задать с помощью действия "Задать время ожидания команды агента IA-Connect".

имя файла журнала агента IA-Connect
IAConnectAgentLogFilename string

Имя файла журнала агента IA-Connect. Это значение уникально для каждого запуска агента IA-Connect, так как он имеет дату и время запуска в имени файла.

Получение свободного места на диске

Возвращает объем свободного места для указанного диска на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Буква диска
DriveLetter True string

Буква диска для проверки.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Байт свободного места на диске
FreeSpaceBytes integer

Объем свободного места на диске в байтах.

Свободное место на диске
FreeSpaceKB integer

Объем свободного места на диске в килобайтах.

Свободное место на диске в МБ
FreeSpaceMB integer

Объем свободного места на диске в мегабайтах.

Свободное место на диске в ГБ
FreeSpaceGB integer

Объем свободного места на диске в гигабайтах.

Получение свойств командной строки идентификатора процесса

Возвращает свойства командной строки для любого выполняемого процесса в сеансе пользователя агента IA-Connect с указанным идентификатором процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
ProcessId True integer

Идентификатор процесса, из которого извлекаются свойства командной строки.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Командная строка обработки
ProcessCommandLine string

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

Аргументы обработки
ProcessArguments string

Аргументы, которые использовались при запуске процесса.

Обработка текущего рабочего каталога
ProcessCurrentWorkingDirectory string

Текущий рабочий каталог процесса.

Имя пути к изображению процесса
ProcessImagePathName string

Путь к исполняемому файлу, который запустил процесс.

Получение следующей задачи автоматизации Orchestrator

Извлекает следующую задачу автоматизации Orchestrator, соответствующую заданным критериям поиска. Можно извлечь только новые и отложенные задачи (которые достигли даты отсрочки). При удержании задачи не будут извлечены.

Параметры

Имя Ключ Обязательно Тип Описание
Имя службы автоматизации
AutomationName string

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

Имена автоматизации
AutomationNames array of string

Если вам нужно вернуть задачи Orchestrator, соответствующие одному из двух или нескольких имен автоматизации, введите имена в этом списке вместо ввода входных данных "Имя службы автоматизации".

Минимальный уровень приоритета
MinimumPriorityLevel integer

Возвращает только задачи автоматизации Orchestrator, имеющие указанный уровень приоритета или более высокий. Например: параметр 2 вернет задачи с уровнем приоритета 1 и 2.

Изменение состояния на
StatusChange string

Если задано значение "Извлечено": при получении задачи состояние задачи изменится на "Извлечено", чтобы запретить другим действиям пытаться выполнить ту же задачу. Если задано значение "Не делать ничего", состояние задачи не изменится.

Минуты до даты отсрочки
MinutesUntilDeferralDate integer

Возвращает только задачи автоматизации Orchestrator, которые готовы выполняться в течение указанного количества минут. Установите значение 0, если вам нужны только задачи автоматизации, готовые к выполнению.

Игнорировать соглашение об уровне обслуживания
IgnoreSLA boolean

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

Исключение идентификаторов задач
ExcludeTaskIds array of integer

Список идентификаторов задач для получения от обработки.

Возвращаемое значение

Имя Путь Тип Описание
Извлекаемая задача
TaskRetrieved boolean

Задайте значение true, если задача была извлечена. Установите значение false, если не было задач, соответствующих критериям поиска.

Идентификатор задачи
TaskId integer

Идентификатор полученной задачи автоматизации Orchestrator.

Идентификатор операции
OperationId string

Идентификатор операции полученной задачи Orchestrator. Этот идентификатор операции (или идентификатор задачи) можно использовать для получения задачи на более позднюю дату. Идентификатор операции является уникальной, неуправляемой строкой, ограничивающей возможность для 3-й стороны угадать идентификатор операции, которая они не создали.

Имя службы автоматизации
AutomationNameOutput string

Имя полученной задачи автоматизации.

Дата и время отсрочки
DeferralDateTime string

Дата и время, когда извлекаемая задача Orchestrator должна быть готова. Эта строка будет возвращена в формате UTC.

Отсрочка хранимых данных
DeferralStoredData string

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

Количество отложений
DeferralCount integer

Как часто эта задача была отложена. Обычно это будет 0 для новой задачи, которая никогда не была отложена или 1 или более для отложенной задачи. Каждый раз, когда отложенная задача была отложена снова, оркестратор автоматически увеличит это число.

Входные данные задачи
TaskInputData string

Необязательные данные, хранящиеся при создании задачи. Обычно это данные, которые использовались для запуска процесса или потока, но это поле можно использовать для любой цели. Это можно отформатировать как любой текстовый формат выбранного текста, например JSON или XML или необработанный текст.

Выходные данные задачи
TaskOutputData string

Необязательные данные, сохраненные автоматизацией при обработке задачи. Это можно отформатировать как любой текстовый формат выбранного текста, например JSON или XML или необработанный текст.

Priority
Priority integer

Уровень приоритета этой задачи Orchestrator (1 — самый высокий).

Состояние задачи автоматизации
AutomationTaskStatus string

Состояние полученной задачи Orchestrator.

Этап процесса
ProcessStage string

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

Дата и время получения
ReceivedDateTime string

Дата и время первоначальной получения задачи оркестратором. Эта строка будет возвращена в формате UTC.

Минуты до даты отсрочки
MinutesUntilDeferralDateOutput integer

Количество минут до даты отсрочки этой задачи (т. е. когда эта задача готова к выполнению). Если эта задача готова к выполнению минут, будет равно 0.

Имя типа источника
SourceTypeName string

Имя источника задачи. Веб-интерфейс представляет задачу вручную, введенную через пользовательский интерфейс. REST API представляет задачу, созданную с помощью REST API Оркестратора. ServiceNow представляет задачу, созданную из внутренней интеграции ServiceNow Orchestrator.

Понятное имя источника
SourceFriendlyName string

Если задача была создана из внутренней интеграции Orchestrator "Источники" (например, ServiceNow), она содержит понятное имя этого источника.

Исходный идентификатор билета
SourceTicketId string

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

Исходный идентификатор дочернего билета
SourceTicketSubId string

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

Организация
Organisation string

Эта задача связана с организацией. Обычно используется для поиска и фильтрации задач.

Отдел
Department string

Эта задача связана с отделом. Обычно используется для поиска и фильтрации задач.

Description
Description string

Описание этой задачи. Обычно используется для поиска и фильтрации задач.

Метки
Tags string

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

Получение содержимого файла в виде Base64

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

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу
FilePath True string

Полный путь к файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Сжимать
Compress boolean

Задайте значение true для GZip, чтобы сжать содержимое файла перед преобразованием в Base64. Файл не связан, все операции выполняются в памяти. Эта функция полезна только в том случае, если вы сможете GUnzip получить содержимое файла после получения Base64 (при декодировании обратно в исходный текст содержимого файла или двоичные данные). Установите значение false, если вы передаете Base64 непосредственно в действие, которое принимает Base64 в качестве входных данных и не имеет функции GUnzip.

Максимальный размер файла
MaxFileSize integer

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Содержимое файла как Base64
FileContentsAsBase64 string

Содержимое файла в формате Base64.

Получение сообщения об ошибке действия из результата потока JSON

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

Параметры

Имя Ключ Обязательно Тип Описание
Результат потока JSON
PowerAutomateResultJSON True array of string

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

Состояние поиска
SearchStatus string

Состояние действия, содержащего сообщение об ошибке. Это следует изменить только в том случае, если вы ищете состояние, отличное от состояния, отличного от значения по умолчанию "Сбой".

Возвращаемое значение

Имя Путь Тип Описание
Сообщение об ошибке действия
ActionErrorMessage string

Возвращает сообщение об ошибке действия, извлеченное из результата JSON. Если сообщение об ошибке не удается найти, возвращается пустое значение.

Название действия
ActionName string

Возвращает имя действия, связанного с сообщением об ошибке.

Код действия
ActionCode string

Возвращает код результата действия, связанного с сообщением об ошибке.

Получение состояния Orchestrator

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

Возвращаемое значение

Имя Путь Тип Описание
Версия Orchestrator
OrchestratorVersion string

Версия программного обеспечения Orchestrator.

Ошибки запуска Orchestrator
NumberOfStartupErrors integer

Количество ошибок запуска Orchestrator.

Время простоя оркестратора в секундах
UptimeInSeconds integer

Количество секунд, запущенных Orchestrator.

Получение состояния доступности рабочей роли Orchestrator

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

Возвращаемое значение

Имя Путь Тип Описание
Общее количество рабочих ролей
TotalWorkersCount integer

Количество IA-Connect работников, определенных в оркестраторе, независимо от того, работают ли они.

Количество доступных рабочих ролей
AvailableWorkersCount integer

Число IA-Connect работников, определенных в Orchestrator, доступных для работы. Доступные означают, что они отвечают, лицензируются, а не в режиме обслуживания, а не в текущий момент выполняются потоки (автоматизация). Это число рабочих, доступных для принятия новых входящих работ.

Число недоступных рабочих ролей
UnavailableWorkersCount integer

Количество IA-Connect рабочих ролей, определенных в Orchestrator, которые недоступны для работы. Это равно общему числу работников, минус число доступных рабочих.

Количество работающих рабочих процессов
WorkersRunningFlowsCount integer

Количество IA-Connect работников, определенных в Оркестраторе, которые выполняют потоки (автоматизация). Эти работники недоступны для работы, потому что они заняты.

Количество рабочих ролей в режиме обслуживания
WorkersInMaintenanceModeCount integer

Количество IA-Connect работников, определенных в оркестраторе, которые находятся в режиме обслуживания. Эти работники недоступны для работы, так как они были настроены вручную, чтобы не принимать новую работу.

Количество рабочих активных работников
LiveWorkersCount integer

Число IA-Connect работников, определенных в Оркестраторе, которые отвечают. Эти работники могут быть недоступны для работы, так как они могут быть нелицензированы, в режиме maintence или запущенных потоках (автоматизация).

Количество лицензированных работников
LicensedWorkersCount integer

Число IA-Connect работников, определенных в Оркестраторе, которые отвечают и лицензируются. Лицензированный работник всегда будет отвечать, так как Оркестратор знает только лицензированное состояние работника, если он отвечает (и, следовательно, уведомляет оркестратора о состоянии). Если работник перестает отвечать, оркестратор больше не будет рассматривать его лицензирован. Эти работники могут или не могут быть доступны для работы, так как они могут находиться в режиме maintence или запущенных потоках (автоматизации).

Получение состояния потока агента

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор потока
ThreadId True integer

Если вы ранее выполнили действие агента в качестве потока, укажите идентификатор потока для получения состояния потока. Этот идентификатор потока будет предоставлен в виде выходных данных предыдущего выполнения действия в качестве потока.

Получение выходных данных потока
RetrieveThreadOutputData boolean

Задайте значение true, чтобы получить выходные данные потока в формате JSON. Рекомендуется получить выходные данные потока, вызвав то же действие, которое используется для создания потока, установив входные данные "Получение выходных данных для идентификатора потока" в идентификатор потока, но этот параметр позволяет напрямую получить выходные данные потока и при необходимости не удалять данные.

Удаление потока после получения выходных данных
ClearOutputDataFromMemoryOnceRead boolean

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Поток начал
ThreadStarted boolean

Значение true, если поток запущен. False, если поток еще не запущен, что предполагает, что что-то пошло не так, так как поток запускается немедленно.

Поток выполняется
ThreadRunning boolean

Значение true, если поток запущен в данный момент. Значение false, если поток никогда не запущен (крайне маловероятно) или если поток завершен.

Поток завершен
ThreadCompleted boolean

Значение true, если поток завершен. Значение false, если поток никогда не запущен (крайне маловероятно) или если поток по-прежнему запущен.

Поток успешно выполнен
ThreadSuccess boolean

Значение true, если поток успешно завершен. Значение false, если поток никогда не запущен (крайне маловероятно), поток по-прежнему выполняется или если поток завершился сбоем.

Среда выполнения потоков в секундах
ThreadRuntimeInSeconds integer

Общее количество секунд, запущенных потоком.

имя действия IA-Connect
IAConnectActionName string

Внутреннее имя действия агента IA-Connect, выполняемого в качестве потока.

Сообщение о состоянии потока
ThreadStatusMessage string

Текстовая строка, описывающая состояние потока. Это сообщение вычисляется из свойств ThreadStarted,ThreadRunning,ThreadCompleted,ThreadSuccess. Эта текстовая строка является независимой от языка (она не изменится на соответствие языковому стандарту).

Сообщение об ошибке потока
ThreadErrorMessage string

Если поток завершился сбоем, этот вывод содержит сообщение об ошибке.

Выходные данные потока JSON
ThreadOutputJSON string

Если для параметра "Получение выходных данных потока" задано значение true, этот вывод содержит необработанные выходные данные потока в формате JSON.

Получение состояния следующего прыжка IA-Connect

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

Параметры

Имя Ключ Обязательно Тип Описание
Проверка запуска директора следующего прыжка
CheckNextHopDirectorIsRunning boolean

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

Проверка запуска агента следующего прыжка
CheckNextHopAgentIsRunning boolean

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Следующий прыжок включен
NextHopEnabled boolean

Возвращает значение true, если следующий прыжок в настоящее время включен.

Адрес директора следующего прыжка
ActiveNextHopDirectorAddress string

Адрес активного директора следующего прыжка, если он используется.

Активный tcp-порт директора следующего прыжка
ActiveNextHopDirectorTCPPort integer

TCP-порт активного директора следующего прыжка, если он используется.

Активный директор следующего прыжка использует HTTPS
ActiveNextHopDirectorUsesHTTPS boolean

Возвращает значение true, если активный директор следующего прыжка использует ПРОТОКОЛ HTTPS.

Активный директор следующего прыжка работает
ActiveNextHopDirectorIsRunning boolean

Возвращает значение true, если запущен активный директор следующего прыжка или значение false, если нет.

URL-адрес директора следующего прыжка
ActiveNextHopDirectorURL string

URL-адрес активного директора следующего прыжка.

Активный агент следующего прыжка запущен
ActiveNextHopAgentIsRunning boolean

Возвращает значение true, если запущен активный агент следующего прыжка или значение false, если нет.

Получение сохраненного пароля

Извлекает ранее созданный или сохраненный пароль.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пароля
PasswordIdentifier string

Идентификатор сохраненного пароля. Эти пароли хранятся только в памяти и теряются при закрытии агента. Например: MyExchangePassword.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Пароль обычного текста
PlainTextPassword string

Пароль в виде обычного текста. Пароль может потребоваться в виде обычного текста, если пароль является одноразовым паролем, предназначенным для передачи с помощью SMS или электронной почты (например), поэтому его необходимо увидеть as-is.

Получение списка дисков

Возвращает список дисков на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Диски JSON
DrivesJSON string

Список дисков на компьютере, на котором запущен агент IA-Connect в формате JSON.

Получение списка принтеров

Возвращает список всех доступных принтеров в сеансе агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Вывод списка локальных принтеров
ListLocalPrinters boolean

Следует ли возвращать локальные принтеры?

Вывод списка сетевых принтеров
ListNetworkPrinters boolean

Следует ли возвращать сетевые принтеры?

Возврат подробных сведений
ReturnDetailedInformation boolean

Должны ли быть возвращены подробные сведения, такие как расположение, имя порта, имя драйвера и состояние каждого принтера?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Принтеры JSON
PrintersJSON string

Список всех принтеров, найденных в формате JSON.

Количество принтеров
NumberOfPrinters integer

Количество найденных принтеров.

Получение списка рабочих ролей Orchestrator

Получите список работников, зарегистрированных в IA-Connect Orchestrator, и их состояние жизни.

Параметры

Имя Ключ Обязательно Тип Описание
Только возвращать живых работников
OnlyReturnLiveWorkers boolean

Задайте значение true, чтобы возвращать только динамические рабочие роли (рабочие, которые активно подключены к Orchestrator).

Возвращаемое значение

Имя Путь Тип Описание
Рабочие оркестраторы
OrchestratorWorkers array of object

Список работников, зарегистрированных в IA-Connect Orchestrator, и их состояние жизни.

Идентификатор
OrchestratorWorkers.Id integer
Имя
OrchestratorWorkers.Name string
CurrentFlowDisplayName
OrchestratorWorkers.CurrentFlowDisplayName string
LiveStatus
OrchestratorWorkers.LiveStatus boolean
LiveStatusLastContactTicks
OrchestratorWorkers.LiveStatusLastContactTicks integer
SecondsSinceLastContact
OrchestratorWorkers.SecondsSinceLastContact integer
MaintenanceMode
OrchestratorWorkers.MaintenanceMode boolean
Priority
OrchestratorWorkers.Priority integer
AgentIsLicensed
OrchestratorWorkers.AgentIsLicensed boolean
IsAvailableForWork
OrchestratorWorkers.IsAvailableForWork boolean
Количество рабочих ролей
NumberOfOrchestratorWorkers integer

Количество работников Orchestrator в ответе.

Получение статистики доступности рабочей роли из Orchestrator

Возвращает статистику доступности рабочей роли из IA-Connect Orchestrator. Используется для создания отчетов. При необходимости можно использовать один или несколько фильтров, чтобы ограничить возвращаемые результаты.

Параметры

Имя Ключ Обязательно Тип Описание
В течение последнего числа дней
WithinLastNumberOfDays integer

Отфильтруйте результаты, чтобы получить только те, которые были запущены в течение последнего указанного числа дней. Установите значение 0, чтобы не фильтровать.

Имя потока
SearchFlowName string

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

Окно запуска потока
SearchFlowStartTimeStartWindow date-time

Отфильтруйте результаты, чтобы получить только те, которые начались после указанного времени начала. Установите значение "Пустой", чтобы не фильтровать. Например: "2022-01-24T07:00:00" вернет все статистики потока оркестратора для потоков, которые начались или после 07.00 часов 24 января 2022 года. Все даты и времени находятся в формате UTC (GMT+0), поэтому вы можете использовать действие Convert DateTime для преобразования локального времени в UTC.

Возвращаемое значение

Имя Путь Тип Описание
Статистика доступности рабочей роли JSON
WorkerAvailabilityStatsJSON string

Список статистики доступности рабочих ролей в формате JSON.

Количество статистики доступности рабочих ролей
NumberOfWorkerAvailabilityStats integer

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

Получение статистики команд IA-Connect

Возвращает всю хранимую статистику, в которой выполняется команда агента IA-Connect в текущем сеансе.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Статистика команд JSON
CommandStatsJSON string

Список команд, выполняемых агентом IA-Connect в текущем сеансе в формате JSON. Этот список будет содержать имя каждого действия и количество выполненных действий.

Получение статистики потока из Orchestrator

Возвращает список статистики потока из IA-Connect Orchestrator. Используется для создания отчетов. При необходимости можно использовать один или несколько фильтров, чтобы ограничить возвращаемые результаты.

Параметры

Имя Ключ Обязательно Тип Описание
В течение последнего числа дней
WithinLastNumberOfDays integer

Отфильтруйте результаты, чтобы получить только те, которые были запущены в течение последнего указанного числа дней. Установите значение 0, чтобы не фильтровать.

Имя потока
SearchFlowName string

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

Результат последнего действия потока
SearchFlowLastActionResult boolean

Фильтруйте результаты, чтобы получить только те, с указанным результатом последнего действия. Задайте значение true, чтобы получить только успешные потоки. Задайте значение false, чтобы получить только неудачные потоки. Не устанавливайте значение и не устанавливайте пустое значение, чтобы не фильтровать результат последнего действия потока.

Окно запуска потока
SearchFlowStartTimeStartWindow date-time

Отфильтруйте результаты, чтобы получить только те, которые начались после указанного времени начала. Установите значение "Пустой", чтобы не фильтровать. Например: "2022-01-24T07:00:00" вернет все статистики потока оркестратора для потоков, которые начались или после 07.00 часов 24 января 2022 года. Все даты и времени находятся в формате UTC (GMT+0), поэтому вы можете использовать действие Convert DateTime для преобразования локального времени в UTC.

Окно окончания времени начала потока
SearchFlowStartTimeEndWindow date-time

Отфильтруйте результаты, чтобы получить только те, которые начались до указанного времени начала. Установите значение "Пустой", чтобы не фильтровать. Например: "2022-01-25T07:00:00" вернет все статистики потока оркестратора для потоков, которые начались или до 07.00 часов 25 января 2022 года. Все даты и времени находятся в формате UTC (GMT+0), поэтому вы можете использовать действие Convert DateTime для преобразования локального времени в UTC.

Возвращаемое значение

Имя Путь Тип Описание
Статистика потока Оркестратора JSON
OrchestratorFlowStatsJSON string

Список всех статистики потока оркестратора в формате JSON.

Количество статистических данных потока
NumberOfOrchestratorFlowStats integer

Количество возвращаемых статистик потока.

Получение текста CSV в виде коллекции

Возвращает CSV-файл на компьютере, где агент IA-Connect работает в качестве коллекции (таблицы). Требуется только доступ только для чтения к CSV-файлу.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к CSV-файлу
CSVFilePath True string

Полный путь к CSV-файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Первая строка — заголовок
FirstLineIsHeader boolean

Первая строка в CSV-файле является строкой заголовка?

Обрезка заголовков
TrimHeaders boolean

Следует ли обрезать заголовки, чтобы удалить любое начальное или конечное пробелы?

Разрешить пустые строки
AllowBlankRows boolean

Если задано значение true (по умолчанию), разрешены полностью пустые строки в данных CSV и будут возвращены в виде пустой строки. Если задано значение false, то в возвращаемых данных будут удалены полностью пустые строки (файл останется неуправляемым).

Расширение столбцов при необходимости
ExtendColumnsIfRequired boolean

Если задано значение true, и если в данных есть ячейки без соответствующего заголовка столбца (т. е. строка с большим числом ячеек, чем строка заголовка), заголовок столбца будет автоматически создан с именем Column_N (где N — индекс столбца). Если задано значение false (значение по умолчанию), будет исключение, если строка содержит данные без соответствующего столбца.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
CSV-данные JSON
CSVDataJSON string

Содержимое CSV-файла в формате JSON.

Получение текущего состояния лицензии агента IA-Connect

Возвращает, является ли агент IA-Connect лицензирован и лицензирован, а если лицензирован, свойства лицензии.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Лицензирован
IsLicensed boolean

Возвращает значение true, если агент IA-Connect в настоящее время лицензирован или имеет значение false, если нет.

Тип лицензии
LicenseType string

Тип используемой лицензии IA-Connect.

Доменное имя агента
CustomerNETBIOSDomainName string

Доменное имя NetBIOS компьютера, на котором запущен агент IA-Connect, если лицензировано по доменному имени (IA-Connect 7.0 или 7.1).

Имена узлов директора
DirectorHostnameCSV string

Имена узлов компьютеров, на которых может быть установлен директор IA-Connect, при лицензировании по имени узла (post IA-Connect 7.2).

Отображаемое имя клиента
CustomerDisplayName string

Имя клиента, отображаемое в строке заголовка агента IA-Connect.

Имя поставщика
VendorName string

Имя поставщика IA-Connect.

Дата окончания срока действия лицензии
LicenseExpiryDate string

Дата окончания срока действия лицензии IA-Connect.

Дни до истечения срока действия лицензии
DaysUntilLicenseExpires integer

Количество оставшихся дней до истечения срока действия лицензии IA-Connect.

Функции лицензии
LicenseFeatures string

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

Лицензия JML
IsJMLLicense boolean

Предоставляет ли эта лицензия доступ к функциям JML.

Получение текущей координаты мыши

Возвращает текущую позицию курсора мыши в сеансе пользователя агента IA-Connect с помощью API setcursorpos.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
X пикселей
X integer

Значение координат X (в пикселях).

Y пикселей
Y integer

Значение координаты Y (в пикселях).

Получение тепловой карты использования рабочего потока из Orchestrator

Возвращает ежедневное использование тепловой карты рабочего потока из IA-Connect Orchestrator. Используется для создания отчетов. При необходимости можно использовать один или несколько фильтров, чтобы ограничить возвращаемые результаты.

Параметры

Имя Ключ Обязательно Тип Описание
Окно запуска потока
SearchStartDateStartWindow True date-time

Фильтрация результатов для получения только тепловой карты использования рабочего потока после указанной даты начала (компонент времени игнорируется). Установите значение "Пустой", чтобы не фильтровать. Например: "2022-01-24T00:00:00" вернет рабочую тепловую карту для потоков, запущенных или после 24 января 2022 года. Все даты и времени находятся в формате UTC (GMT+0), поэтому вы можете использовать действие Convert DateTime для преобразования локального времени в UTC.

Окно окончания времени начала потока
SearchStartDateEndWindow True date-time

Фильтруйте результаты, чтобы получить только тепловую карту использования рабочего потока до указанной даты начала (компонент времени игнорируется). Установите значение "Пустой", чтобы не фильтровать. Например: "2022-01-25T00:00:00" вернет рабочую тепловую карту для Потока, которая началась или до 25 января 2022 года. Все даты и времени находятся в формате UTC (GMT+0), поэтому вы можете использовать действие Convert DateTime для преобразования локального времени в UTC.

Смещение часового пояса в формате UTC
TimeZoneMinutesOffsetFromUTC integer

Смещение часового пояса из UTC в минутах для выравнивания ежедневной тепловой карты. Например: если указать 60 минут, ежедневные тепловые карты выполняются от 01:00 UTC до 01:00 UTC.

IA-Connect имена рабочих ролей
WorkerNames string

Список имен IA-Connect Рабочих ролей для возврата тепловой карты в формате JSON или CSV. Если оставить пустым, то тепловая карта будет создана для всех работников, известных оркестратору. Например: [{"WorkerName": "Worker1"}, {"WorkerName": "Worker2"}] (формат таблицы JSON), ["Worker1", "Worker2"] (формат массива JSON) или Worker1,Worker2 (формат CSV).

Возвращаемое значение

Имя Путь Тип Описание
Рабочая карта использования тепловой карты JSON
WorkerFlowUsageHeatmapJSON string

Тепловая карта использования рабочего потока в формате JSON.

Количество элементов тепловой карты использования рабочего потока
NumberOfWorkerFlowUsageHeatmapItems integer

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

Получение умножения мыши

Извлекает глобальный умножитель мыши в сеансе пользователя агента IA-Connect. Это значение по умолчанию имеет значение (1, 1), но может быть изменено действием "Задать умножение мыши".

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Умножение X
MouseXMultiplier double

Текущий глобальный умножитель мыши по горизонтали (X) (если агент перемещает мышь). Умножение действует только в том случае, если отключена функция мультиметрии.

Умножение Y
MouseYMultiplier double

Текущий глобальный умножитель мыши по вертикали (Y) (для при перемещении агента мыши). Умножение действует только в том случае, если отключена функция мультиметрии.

Метод перемещения мыши
MouseMoveMethod string

Возвращает текущий глобальный метод перемещения мыши (mouse_event или setcursorpos).

Получение универсальных учетных данных из Orchestrator

Извлекает универсальные учетные данные, хранящиеся в IA-Connect Orchestrator. Учетные данные могут содержать имена пользователей, пароли, имена узлов, URL-адреса и другие универсальные данные.

Параметры

Имя Ключ Обязательно Тип Описание
Дружественное имя
FriendlyName string

Понятное имя учетных данных, хранящихся в Orchestrator.

Получение пароля обычного текста
RetrievePlainTextPassword boolean

Если установлен флажок, пароль для указанных универсальных учетных данных Orchestrator будет возвращен как обычный текст, если параметр универсального учетных данных Orchestrator "Не предоставлять пароль" отключен (разрешить получение паролей). Рекомендуется не извлекать пароли в виде обычного текста, а вместо этого использовать IA-Connect действия, поддерживающие сохраненные пароли (например, "Входной пароль в действие UIA"), где Оркестратор вставляет пароль непосредственно в действие во время выполнения.

Возвращаемое значение

Имя Путь Тип Описание
Имя пользователя
Username string

Имя пользователя, которое хранится в универсальных учетных данных.

Пароль обычного текста
PlainTextPassword string

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

Имя хоста
Hostname string

Имя узла или доменное имя, которое хранится в универсальных учетных данных, если используется.

URL
Url string

URL-адрес, который хранится в универсальных учетных данных, если используется.

Универсальное свойство 1
GenericProperty1 string

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

Универсальное свойство 2
GenericProperty2 string

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

Универсальное свойство 3
GenericProperty3 string

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

Получение уровня журнала агента IA-Connect

Возвращает текущий уровень ведения журнала агента IA-Connect. Уровни ведения журнала задаются от 1 до 4, при этом 1 — самый низкий уровень и 4 — самый высокий.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Уровень журнала
LoggingLevel integer

Текущий уровень ведения журнала агента IA-Connect.

имя файла журнала агента IA-Connect
IAConnectAgentLogFilename string

Имя файла журнала агента IA-Connect. Это значение уникально для каждого запуска агента IA-Connect, так как он имеет дату и время запуска в имени файла.

Получение уровня журнала директора IA-Connect

Возвращает текущий уровень ведения журнала IA-Connect директора. Уровни ведения журнала задаются от 0 до 4. Значение 0 отключено. 1 — самый низкий уровень журнала (и по умолчанию). 4 — самый высокий уровень журнала.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Уровень журнала
LoggingLevel integer

Текущий уровень ведения журнала директора IA-Connect.

имя файла журнала IA-Connect директора
IAConnectDirectorLogFilename string

Имя файла журнала IA-Connect директора. Это значение уникально для каждого запуска, так как оно имеет дату и время запуска в имени файла.

Получение файлов

Возвращает список файлов в папке (соответствующий csv-списку шаблонов) на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к каталогу
DirectoryPath True string

Полный путь к каталогу (папке). Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Шаблоны CSV
PatternsCSV True string

Список шаблонов файлов, разделенных запятыми , например для всех файлов или.txt,.docxдля файлов с расширением .txt или .docx.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Файлы JSON
FilesJSON string

Список файлов, содержащихся в папке, в формате JSON.

Количество файлов, которые успешно считываются
NumberOfFilesReadSuccessfully integer

Количество файлов, которые были успешно прочитаны.

Количество файлов, которые не удалось прочитать
NumberOfFilesFailedToRead integer

Количество файлов, которые не удалось прочитать.

Получение цвета пикселей в координате

Возвращает цвет RGB пикселя в заданной координате.

Параметры

Имя Ключ Обязательно Тип Описание
Левый X пикселей
LeftXPixels True integer

Положение X пикселя для чтения. На одном дисплее левый x-пиксель равен 0. На дисплее с несколькими мониторами левая часть X может быть отрицательной (в зависимости от того, какой дисплей помечается как основной и где он относительно других дисплеев).

Верхние пиксели Y
TopYPixels True integer

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

Скрыть агент
HideAgent boolean

Установите значение true, чтобы автоматически скрыть агент (если видимый), чтобы убедиться, что он не скрывает пиксель, считываемый.

Использование физических координат
UsePhysicalCoordinates boolean

Задайте значение true, чтобы указать, что предоставленные координаты являются физическими (не масштабируемыми DPI и, следовательно, совпадают с физическими пикселями на дисплее). Задайте значение false (значение по умолчанию), чтобы указать, что предоставленные координаты являются виртуальными (масштабируемыми DPI). Действия UIA, Java и Web обычно используют виртуальные координаты.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Красное значение
RedValue integer

Возвращает красное значение пикселя от 0 (без красного) до 255 (полный красный).

Зеленое значение
GreenValue integer

Возвращает зеленое значение пикселя от 0 (без зеленого) до 255 (полно зеленый).

Синее значение
BlueValue integer

Возвращает синее значение пикселя от 0 (без синего) до 255 (полного синего).

Альфа-значение
AlphaValue integer

Возвращает альфа-значение пикселя от 0 (полностью прозрачно) до 255 (полностью непрозрачно).

Шестнадцатеричное значение RRGGBB
RRGGBBHexValue string

Возвращает шестнадцатеричное значение RRGGBB пикселя. Например: FF0000 полностью красный, 00FF00 полностью зеленый, 0000FF синий, 000000 является черным, FFFFFF полный белый.

Шестнадцатеричное значение AARRGGBB
AARRGGBBHexValue string

Возвращает шестнадцатеричное значение пикселя AARRGGBB, которое совпадает с RRGGBB, но с шестнадцатеричным альфа-значением, включенным в начало. Для полностью непрозрачных пикселей (наиболее распространенных), это будет содержать значение FFRRGGBB. Например, FFFF0000 полностью непрозрачный красный.

Пометить поток как завершенный

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

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Посередине щелчка мыши

Нажмите кнопку средней мыши в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Посередине щелчка мыши по координате

Щелкает среднюю кнопку мыши в сеансе пользователя агента IA-Connect по указанным координатам. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Параметры

Имя Ключ Обязательно Тип Описание
X пикселей
XCoord True integer

Значение координат X (в пикселях).

Y пикселей
YCoord True integer

Значение координаты Y (в пикселях).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Правая кнопка мыши вверх

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

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Правая кнопка мыши вниз

Нажимает (и не освобождает) правую кнопку мыши в сеансе пользователя агента IA-Connect. Чтобы освободить мышь, используйте правое действие мыши вверх.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Преобразование координат прямоугольника

Преобразует координату пикселя прямоугольника из виртуальной в физическую или физическую в виртуальную. Если вы хотите преобразовать точку, просто установите right=Left и Bottom=Top. Физические координаты сопоставляют непосредственно с пикселями на мониторе. Виртуальные координаты масштабируются. Если базовое масштабирование всех устройств отображения равно 100%, физические и виртуальные координаты одинаковы.

Параметры

Имя Ключ Обязательно Тип Описание
Прямоугольник левого края экрана пиксель X-координаты
RectangleLeftPixelXCoord True integer

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

Прямоугольник верхнего края экрана с координатами Y
RectangleTopPixelYCoord True integer

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

Прямоугольник правого края экрана пиксель X-координаты
RectangleRightPixelXCoord True integer

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

Прямоугольник нижнего края экрана с координатами Y
RectangleBottomPixelYCoord True integer

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

Тип преобразования
ConversionType True string

Тип преобразования: от физического до виртуального (PhysicalToVirtual или P2V) или виртуального на физический (VirtualToPhysical или V2P).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Преобразованный прямоугольник в левом краю экрана пикселей X-координат
ConvertedRectangleLeftPixelXCoord integer

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

Преобразованный прямоугольник верхнего края пикселя Y-координаты
ConvertedRectangleTopPixelYCoord integer

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

Преобразованный прямоугольник правого края пикселя X-координаты
ConvertedRectangleRightPixelXCoord integer

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

Преобразованный прямоугольник нижнего края экрана пиксель Y-координаты
ConvertedRectangleBottomPixelYCoord integer

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

Преобразованная ширина прямоугольника
ConvertedRectangleWidth integer

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

Преобразованная высота прямоугольника
ConvertedRectangleHeight integer

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

Присоединение к последнему сеансу IA-Connect

Присоединяется к сеансу директора IA-Connect, который недавно подключен (необязательно указанного типа). Это сеанс, в который отправляются команды агенту IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Поиск IA-Connect типа сеанса
SearchIAConnectSessionType string

Тип сеанса для поиска, например "Локальный агент", "Microsoft RDP", "Citrix ICA" или "Remote" для любого типа удаленного сеанса. Оставьте пустым для поиска любого типа сеанса.

Время ожидания в секундах
TimeToWaitInSeconds integer

Если сеанс указанного типа отсутствует (если указан определенный тип), сколько времени IA-Connect ждать его?

Вызов исключения при истечении времени ожидания
RaiseExceptionIfTimedout boolean

Следует ли IA-Connect вызывать исключение, если новый сеанс не подключен до истечения периода ожидания?

Виртуальный канал должен быть подключен
VirtualChannelMustBeConnected boolean

Должен ли директор IA-Connect проверить, подключен ли виртуальный канал при подключении к сеансу? Это гарантирует, что агент IA-Connect работает в указанном сеансе.

Только количество сеансов, которые не видели раньше
OnlyCountSessionsNotSeenBefore boolean

Если задано значение true, то любые сеансы, отображаемые ранее, выполнялись действием Get available IA-Connect session (или IA-Connect Inspector просмотр сеансов), не будут считаться в индексе. Это позволяет подсчитывать только новые сеансы (например, присоединиться к первому новому сеансу Citrix).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Присоединенное имя сеанса IA-Connect
AttachedIAConnectSessionName string

Имя присоединенного к IA-Connect сеанса.

Присоединено к сеансу
AttachedToSession boolean

Возвращает значение true, если IA-Connect подключен к сеансу или значение false, если нет.

Присоединение к сеансу IA-Connect по имени

Присоединяется к указанному сеансу директора IA-Connect по имени. Это сеанс, в который отправляются команды агенту IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
имя сеанса IA-Connect
IAConnectSessionName True string

Имя сеанса IA-Connect для подключения.

Виртуальный канал должен быть подключен
VirtualChannelMustBeConnected boolean

Должен ли директор IA-Connect проверить, подключен ли виртуальный канал при подключении к сеансу? Это гарантирует, что агент IA-Connect работает в указанном сеансе.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Присоединение к сеансу IA-Connect по индексу

Присоединяется к указанному сеансу директора IA-Connect по индексу (например, присоединение к первому сеансу Citrix ICA). Это сеанс, в который отправляются команды агенту IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Поиск IA-Connect типа сеанса
SearchIAConnectSessionType string

Тип сеанса для поиска, например "Локальный агент", "Microsoft RDP", "Citrix ICA" или "Remote" для любого типа удаленного сеанса. Оставьте пустым для поиска любого типа сеанса.

Поиск индекса сеанса IA-Connect
SearchIAConnectSessionIndex integer

Индекс сеанса для подключения, например 1 для первого соответствующего типа сеанса, 2 для второго типа сеанса сопоставления.

Время ожидания в секундах
TimeToWaitInSeconds integer

Если сеанс с указанным индексом не существует, сколько времени IA-Connect ждать его?

Вызов исключения при истечении времени ожидания
RaiseExceptionIfTimedout boolean

Следует ли IA-Connect вызывать исключение, если новый сеанс не подключен до истечения периода ожидания?

Виртуальный канал должен быть подключен
VirtualChannelMustBeConnected boolean

Должен ли директор IA-Connect проверить, подключен ли виртуальный канал при подключении к сеансу? Это гарантирует, что агент IA-Connect работает в указанном сеансе.

Только количество сеансов, которые не видели раньше
OnlyCountSessionsNotSeenBefore boolean

Если задано значение true, то любые сеансы, отображаемые ранее, выполнялись действием Get available IA-Connect session (или IA-Connect Inspector просмотр сеансов), не будут считаться в индексе. Это позволяет подсчитывать только новые сеансы (например, присоединиться к первому новому сеансу Citrix).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Присоединенное имя сеанса IA-Connect
AttachedIAConnectSessionName string

Имя присоединенного к IA-Connect сеанса.

Присоединено к сеансу
AttachedToSession boolean

Возвращает значение true, если IA-Connect подключен к сеансу или значение false, если нет.

Процесс выполнения

Запустите процесс, команду или приложение.

Параметры

Имя Ключ Обязательно Тип Описание
Имя процесса
ProcessName True string

Процесс выполнения. например, notepad.exe или C:\windows\system32\notepad.exe. Агент IA-Connect развернет все переменные среды в пути.

Arguments
Arguments string

Все аргументы командной строки, используемые при запуске приложения.

Рабочая папка
WorkingDirectory string

Рабочая папка или каталог для процесса. Агент IA-Connect развернет все переменные среды в пути.

Использование выполнения оболочки
UseShellExecute boolean

Следует ли запустить процесс с помощью оболочки операционной системы?

Создание окна без
CreateNoWindow boolean

Следует ли запустить процесс без окна?

Стиль окна
WindowStyle string

Укажите стиль окна (обычный, максимизированный, минимизированный или скрытый).

Ожидание процесса
WaitForProcess boolean

Следует ли ждать завершения процесса? Это, скорее всего, будет использоваться только при выполнении программы или скрипта, необходимого для завершения, прежде чем мы можем продолжить.

Перенаправление стандартных выходных данных
RedirectStandardOutput boolean

Следует ли перенаправление стандартных выходных данных?

Стандартная ошибка перенаправления
RedirectStandardError boolean

Следует ли перенаправить стандартную ошибку?

Перенаправление стандартной ошибки в выходные данные
RedirectStandardErrorToOutput boolean

Должна ли стандартная ошибка перенаправляться на выходные данные?

Стандартная кодировка выходных данных
StandardOutputEncoding string

Укажите стандартную кодировку выходных данных (UTF8, UTF7, UTF16, ASCII или UTF16BE).

Стандартная кодировка ошибок
StandardErrorEncoding string

Укажите стандартную кодировку ошибок (UTF8, UTF7, UTF16, ASCII или UTF16BE).

Имя домена RunAs
RunAsDomain string

Домен запуска от имени пользователя. Если домен не указан, имя пользователя должно быть в формате username@domainFQDN.

Имя пользователя RunAs
RunAsUsername string

Имя пользователя запуска от имени пользователя.

Пароль запуска
RunAsPassword password

Пароль запуска от имени пользователя.

Загрузка профиля пользователя runAs
RunAsLoadUserProfile boolean

Должен ли быть загружен профиль пользователя Windows запуска от имени пользователя?

Повышенные привилегии RunAs
RunAsElevate boolean

Должен ли процесс выполняться с повышенными привилегиями?

Время ожидания в секундах
TimeoutInSeconds integer

Максимальное количество секунд, дожидающегося завершения процесса.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Начало процесса
ProcessStarted boolean

Возвращает значение true, если процесс был запущен.

Код выхода
ExitCode integer

Возвращает код выхода процесса.

Время ожидания процесса
ProcessTimedOut boolean

Возвращает значение true, если время ожидания процесса истекло.

Идентификатор процесса
ProcessId integer

Идентификатор процесса, который был запущен.

Стандартные выходные данные
StandardOutput string

Стандартное содержимое выходных данных.

Стандартная ошибка
StandardError string

Стандартное содержимое ошибки.

Процесс убийства

Убивает любой запущенный процесс в сеансе пользователя агента IA-Connect с указанным именем процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Имя процесса
ProcessName True string

Процесс, который нужно убить. Например, блокнот.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Число убитых процессов
NumberOfProcessesKilled integer

Число убитых процессов.

Разблокировка сеанса

Разблокирует сеанс, в котором запущен агент IA-Connect. Для этого требуется, чтобы поставщик учетных данных IA-Connect разблокировки был установлен на компьютере, где размещен сеанс, так как только поставщик учетных данных может разблокировать компьютер.

Параметры

Имя Ключ Обязательно Тип Описание
Разблокировка пароля
UnlockPassword True string

Пароль для разблокировки текущего сеанса. Это пароль пользователя Windows для учетной записи, вошедшего в сеанс, который в настоящее время заблокирован. Если это пароль "Сохраненный", введите в формате {IAConnectPassword:StoredPasswordIdentifier} и задайте для входных данных "сохраненный пароль" значение true. Если это универсальные учетные данные Orchestrator, введите в формате {OrchestratorCredential:FriendlyName} и задайте для входных данных "сохраненный пароль" значение true.

Пароль содержит сохраненный пароль
PasswordContainsStoredPassword boolean

Задайте значение true, если пароль является IA-Connect сохраненным идентификатором пароля (например, созданным действием "Создать пароль") или универсальными учетными данными оркестратора IA-Connect (например, при использовании IA-Connect с потоком PA).

Определить, заблокировано ли
DetectIfLocked True boolean

Если агент IA-Connect пытается определить, заблокирован ли сеанс. Если задано значение true, и сеанс не обнаруживается как заблокированный, это действие просто не будет делать ничего (так как ничего не делать). Задано значение false, если IA-Connect неправильно определяет, заблокирован ли сеанс, и вы хотите принудительно выполнить попытку разблокировки (которая завершится ошибкой, если сеанс не заблокирован).

Обнаружение поставщика учетных данных
DetectCredentialProvider True boolean

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

Секунды ожидания разблокировки
SecondsToWaitForUnlock integer

Сколько времени (в секундах) агент IA-Connect ожидает подтверждения успешного разблокировки рабочего стола (путем обнаружения состояния разблокировки рабочего стола). По умолчанию это до 5 секунд. Установите значение 0, чтобы отключить эту функцию и продолжить без проверки разблокировки рабочего стола.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Разблокировка сеанса выполнена
SessionUnlockPerformed boolean

Установите значение true, если сеанс заблокирован и выполнено действие разблокировки. Установите значение false, если сеанс не был заблокирован, а параметр "Определить, заблокирован ли" имеет значение true, что приводит к тому, что действие не выполняется.

Разверните строку пароля

Принимает входную строку, содержащую ссылки на IA-Connect сохраненных паролей и возвращает эту строку со ссылками, замененными сохраненными паролями.

Параметры

Имя Ключ Обязательно Тип Описание
Входная строка
InputString string

Входная строка, содержащая IA-Connect хранимые идентификаторы паролей. Например: "Приветствие нового начального элемента, пароль новой учетной записи — {IAConnectPassword:GeneratedPassword}", где "GeneratedPassword" — это имя сохраненного IA-Connect пароля.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Строка вывода
OutputString string

Выходная строка, содержащая входную строку с идентификаторами паролей, замененной фактическими паролями. Например: "Приветствие нового начального элемента, пароль новой учетной записи — Fantastic12Monkeys!".

Развертывание переменной среды

Расширяет строку, содержащую переменные среды (например, %USERPROFILE% или %TEMP%) в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Входная строка
InputString True string

Входная строка, содержащая переменные среды.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Строка вывода
OutputString string

Строка с развернутыми переменными среды.

Разрыв наследования папок

Прерывает наследование безопасности на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к папке
FolderPath True string

Полный путь к папке. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Преобразование наследуемого в явное
ConvertInheritedToExplicit boolean

Следует ли преобразовать какие-либо наследуемые в настоящее время разрешения в явные разрешения?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Рисование прямоугольника на экране

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

Параметры

Имя Ключ Обязательно Тип Описание
Прямоугольник левого края экрана пиксель X-координаты
RectangleLeftPixelXCoord True integer

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

Прямоугольник правого края экрана пиксель X-координаты
RectangleRightPixelXCoord True integer

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

Прямоугольник верхнего края экрана с координатами Y
RectangleTopPixelYCoord True integer

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

Прямоугольник нижнего края экрана с координатами Y
RectangleBottomPixelYCoord True integer

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

Цвет пера
PenColour string

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

Пиксели толщины пера
PenThicknessPixels integer

Толщина (в пикселях) границы прямоугольника выделения.

Секунды для отображения
SecondsToDisplay integer

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

Координаты являются физическими
CoordinatesArePhysical boolean

Установите значение true, если указанные координаты являются физическими координатами экрана. Установите значение false, если предоставленные координаты являются виртуальными. Если базовое масштабирование дисплея равно 100%, физические и виртуальные координаты одинаковы.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
DrawRectangleOnScreenResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Сброс параметров следующего прыжка IA-Connect директора

Сбрасывает все настраиваемые параметры IA-Connect директора, которые были установлены, восстанавливая параметры по умолчанию.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Сброс статистики команд IA-Connect

Сбрасывает любую хранимую статистику, в которой команда агента IA-Connect выполнена в текущем сеансе.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Скачивание HTTP-файла

Загружает файл на компьютер, на котором выполняется агент IA-Connect с помощью ПРОТОКОЛА HTTP(S).

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес скачивания
DownloadURL True string

URL-адрес скачивания HTTP или HTTPS.

Путь к файлу сохранения
SaveFilename string

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

Перезаписать существующий файл
OverwriteExistingFile boolean

Если файл уже существует с именем, указанным в входных данных "Сохранить путь к файлу", его следует перезаписать?

Сквозная проверка подлинности
PassthroughAuthentication boolean

Следует ли передавать учетные данные пользователя на веб-сервер? Обычно это используется только для внутренних сайтов интрасети.

Агент пользователя
UserAgent string

Это позволяет задать агент пользователя, сообщаемого на веб-странице. Обычно это не обязательно и следует изменять только в том случае, если для веб-страницы требуется определенная строка агента.

Принять
Accept string

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

Поддержка TLS10
SupportTLS10 boolean

Установите значение True для поддержки протокола шифрования TLS 1.0.

Поддержка TLS11
SupportTLS11 boolean

Установите значение True для поддержки протокола шифрования TLS 1.1.

Поддержка TLS12
SupportTLS12 boolean

Установите значение True для поддержки протокола шифрования TLS 1.2.

Автоматическое декомпрессия deflate
AutoDecompressDeflate boolean

Некоторые веб-содержимое возвращается сжато с помощью сжатия "deflate". При задании этого значения значение True сообщает веб-серверу, что "deflate" поддерживается, и, если содержимое отправляется с помощью этого сжатия, оно будет автоматически распаковываться.

Автоматическое распаковка GZip
AutoDecompressGZIP boolean

Некоторые веб-содержимое возвращается сжато с помощью сжатия GZIP. При задании этого значения значение True сообщает веб-серверу, что "GZIP" поддерживается и, если содержимое отправляется с помощью этого сжатия, оно будет автоматически распаковываться.

Возврат содержимого в виде строки
ReturnContentsAsString boolean

Следует ли возвращать содержимое файла в виде строки?

Возврат кодирования содержимого
ReturnContentEncoding string

Кодировка скачаемого содержимого. Это используется только в том случае, если значение "Возвращаемое содержимое в виде строки" имеет значение True и определяет кодировку скачаемого содержимого, чтобы его можно было интерпретировать правильно.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Скачивание содержимого файла
DownloadFileContents string

Содержимое скачаированного файла.

Снимок экрана

Снимок экрана: сеанс пользователя агента IA-Connect и возвращает его в виде строки в кодировке Base64.

Параметры

Имя Ключ Обязательно Тип Описание
Полноэкранный режим
Fullscreen boolean

Должен ли снимок экрана включать весь экран?

Левый X пикселей
LeftXPixels integer

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

Верхние пиксели Y
TopYPixels integer

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

Пиксели ширины
WidthPixels integer

Если не делать снимок экрана всего экрана, ширина снимка экрана с начальной позиции.

Пиксели высоты
HeightPixels integer

Если не снимок экрана всего экрана, высота снимка экрана с начальной позиции.

Формат изображения
ImageFormat string

Укажите формат изображения (PNG, JPG, BMP или GIF).

Использование устройства отображения
UseDisplayDevice boolean

Следует ли агенту IA-Connect учитывать сведения об устройстве отображения? Это будет лучше работать с масштабированием DPI и обеспечит поддержку для нескольких дисплеев.

Вызов исключения при ошибке
RaiseExceptionOnError boolean

Если задано значение true: агент IA-Connect вызовет исключение, если снимок экрана завершается сбоем (например, если сеанс заблокирован). Если задано значение false: IA-Connect вернет пустое растровое изображение, если снимок экрана завершается ошибкой, и будет заполнен выходными данными "Снимок экрана" и "Сообщение об ошибке снимок экрана".

Скрыть агент
HideAgent boolean

Установите значение true, чтобы автоматически скрыть агент (если видимый), чтобы убедиться, что он не скрывает снимок экрана.

Использование физических координат
UsePhysicalCoordinates boolean

Задайте значение true, чтобы указать, что предоставленные координаты являются физическими (не масштабируемыми DPI и, следовательно, совпадают с физическими пикселями на дисплее). Задайте значение false (значение по умолчанию), чтобы указать, что предоставленные координаты являются виртуальными (масштабируемыми DPI). Действия UIA, Java и Web обычно используют виртуальные координаты.

Отображение идентификатора устройства
DisplayDeviceId integer

Эти входные данные работают только в том случае, если для входных данных "Использование устройства отображения" задано значение true. Установите значение 0 (по умолчанию), чтобы включить все мониторы. Установите значение 1, чтобы включить только основной монитор. Установите значение 2 или выше, чтобы включить только соответствующий вторичный монитор.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Изображение экрана как Base64
ScreenBitmapBase64 string

Изображение экрана в виде строки в кодировке Base64. Это можно просмотреть с помощью предоставленной служебной программы Base64 для растрового изображения.

Снимок экрана успешно
ScreenshotSuccessful boolean

Установите значение true, если снимок экрана выполнен успешно. Установите значение false, если снимок экрана завершился сбоем, а для ошибки задано значение false. Исключение будет возникать, если снимок экрана завершился сбоем, а для свойства "Создать исключение по ошибке" задано значение true.

Снимок экрана: сообщение об ошибке
ScreenshotErrorMessage string

Если снимок экрана завершился сбоем, а для параметра "Создать исключение по ошибке" задано значение false, это поле выходных данных будет содержать сообщение об ошибке. Это альтернатива параметру "Создать исключение по ошибке" значение true, что приведет к исключению при возникновении ошибки при выполнении снимка экрана.

Создание единовременного секрета Orchestrator

Одноразовый секрет предоставляет объект для хранения секрета, который можно получить один раз с помощью неуправляемого уникального URL-адреса. Обычно это используется для совместного использования секретов с 3-й стороной. Вы можете создать одноразовый секрет с помощью пользовательского интерфейса Orchestrator, REST API или потока.

Параметры

Имя Ключ Обязательно Тип Описание
Дружественное имя
FriendlyName True string

Это описательное имя, которое исключительно используется для идентификации этого одноразового секрета. Единственной целью этого имени является просмотр в списке секретов в пользовательском интерфейсе Orchestrator.

Значение секрета
SecretValue password

Однократное значение секрета, которое вы хотите предоставить и сделать доступным с помощью одноразового URL-адреса.

Фраза получения 1
RetrievalPhrase1 password

Это фраза, необходимая для получения одноразового секрета с помощью уникального URL-адреса. Если осталось пустым, фраза извлечения не потребуется. Этапы извлечения чувствительны к регистру.

Фраза получения 2
RetrievalPhrase2 password

Это вторая фраза, необходимая для получения однократного секрета с помощью уникального URL-адреса. Если осталось пустым, фраза извлечения не потребуется. Этапы извлечения чувствительны к регистру.

Максимальное количество повторных операций перед удалением
MaximumRetrievalsBeforeDeletion integer

Сколько раз можно получить этот одноразовый секрет, прежде чем удалить его из Orchestrator? По умолчанию это значение равно 1 (однократно). Для нескольких пользователей необходимо получить доступ к этому секрету только более высокое значение.

Секрет имеет дату начала
SecretHasAStartDate boolean

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

Дата и время начала секрета
SecretStartDateTime date-time

Дата и время, когда этот секрет станет доступным для получения. Даты и время вводятся в формате dd/MM/гггг HH:mm, а также хранятся и обрабатываются в формате UTC/ GMT+0. Например: "2022-01-24T07:00:00" остановит одноразовый секрет от извлечения до 07.00 часов UTC (GMT+0) 24 января 2022 г. (вы получите 404). Кроме того, используйте входные данные "Часы до времени начала секрета". При использовании этих входных данных необходимо задать значение "Секрет имеет дату начала" значение true, или входные данные будут игнорироваться.

Часы до времени начала секрета
HoursUntilSecretStartTime integer

Количество часов, пока этот секрет не будет доступен для получения. Кроме того, используйте входные данные "Дата и время начала секрета". При использовании этих входных данных необходимо задать значение true "Секрет имеет дату начала".

Секрет имеет дату окончания срока действия
SecretHasAnExpiryDate boolean

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

Дата и время окончания срока действия секрета
SecretExpiryDateTime date-time

Дата и время автоматического удаления этого секрета независимо от того, была ли она извлечена. Даты и время вводятся в формате гггг-ММ-ддTHH:mm:ss и хранятся и обрабатываются в формате UTC/ GMT+0. Например: "2022-01-24T07:00:00" удалит одноразовый секрет в 07.00 часов UTC (GMT+0) 24 января 2022 года. Кроме того, используйте входные данные "Часы до истечения срока действия секрета". При использовании этих входных данных необходимо задать значение true "Секрет имеет дату окончания срока действия", или входные данные будут игнорироваться.

Часы до истечения срока действия секрета
HoursUntilSecretExpiry integer

Количество часов, пока этот секрет не будет удален автоматически, независимо от того, был ли он получен. Кроме того, используйте входные данные "Дата и время окончания срока действия секрета". При использовании этих входных данных необходимо задать значение "Секрет имеет дату окончания срока действия" значение true.

Возвращаемое значение

Имя Путь Тип Описание
URL-адрес получения
RetrievalURL string

Одноразовый URL-адрес, используемый для извлечения одноразового секрета.

Идентификатор извлечения
RetrievalId string

Уникальный идентификатор извлечения. Этот одноразовый URL-адрес создается из этого уникального идентификатора. Этот идентификатор может оказаться полезным, если необходимо создать собственный URL-адрес в пользовательском сценарии.

Создание исключения

Создайте исключение с указанным сообщением, если входное исключение не является пустым. Это полезно для активации сообщения об исключении в потоке (HTTP 400), которое затем будет поймано этапом обработки ошибок, если предыдущее действие имело ошибку. Это исключение не записывается в статистике выполнения потока оркестратора IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Исключение входных данных
InputException string

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

Сообщение об исключении
ExceptionMessage string

Возникает сообщение об исключении.

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
RaiseExceptionResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Создание пароля

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

Параметры

Имя Ключ Обязательно Тип Описание
Формат пароля
PasswordFormat True string

Формат созданного пароля, описанного с помощью символов. Символ "w" представляет слово словаря, "u" представляет слово словаря в верхнем регистре, "n" представляет число, "s" представляет символ, "l" представляет букву нижнего регистра, "L" представляет букву верхнего регистра, "Z" не представляет ничего (полезного в сочетаниях). Например, wnnwsl может создать Pluto35Marmite!b. Число, за которым следует два или более символов в фигурных скобках, создаст случайное сочетание этого числа символов. Например, 8(Lln) может производить 6hP2AxP0 и 4(Lsz) могут производить символы S!-A (LssL) или создавать символы J$ (Lszz). Символы внутри отдельных кавычки используются as-is. Например, w'---w'nn может производить Джерси-Mountain_64.

Минимальная длина
MinimumLength integer

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

Возврат в виде обычного текста
ReturnAsPlainText boolean

Задайте значение true, чтобы вернуть пароль в виде обычного текста.

Хранение пароля в качестве идентификатора
StorePasswordAsIdentifier string

Если указан идентификатор, этот пароль будет храниться в оркестраторе или агенте (см. раздел "Создать по адресу") для последующего получения или использования любыми командами, которые могут использовать сохраненные учетные данные. При создании агента эти пароли хранятся только в памяти и теряются при закрытии агента. Например, MyExchangePassword будет извлечен с помощью {IAConnectPassword:MyExchangePassword}.

Поддерживаемые символы
SupportedSymbols string

Позволяет указать список символов, которые будут случайным образом использоваться при использовании символа "s" в формате созданного пароля. Если это не указано, используется встроенный список. Например: !$()*.

Попытка уникальных паролей
AttemptUniquePasswords boolean

Установите значение true (по умолчанию) для оркестратора или агента (см. раздел "Создать по адресу"), чтобы избежать дублирования последовательностей случайных чисел и, следовательно, убедитесь, что созданные пароли уникальны, где это возможно в рамках определенного сеанса. Если агент создает агент, это не гарантирует уникальных паролей между отдельными агентами или если агент закрыт или перезапущен, поэтому всегда следует убедиться, что пароли являются весьма случайными с помощью сложных паролей (например, wnnws является более случайным, чем wnw).

Создать по адресу
GenerateAt string

Укажите, какой компонент IA-Connect создаст пароль.

Минимальный нижний регистр
MinimumLowercase integer

Минимальное число строчных символов, которые должны присутствовать в пароле. Если это невозможно (например, если в формате пароля недостаточно символов l, w или u), будет возникать исключение. Установите значение 0 без минимального значения.

Минимальный верхний регистр
MinimumUppercase integer

Минимальное число символов верхнего регистра, которое должно присутствовать в пароле. Если это невозможно (например, если формат пароля не имеет достаточно символов L, w или u), создается исключение. Установите значение 0 без минимального значения.

Минимальное число
MinimumNumbers integer

Минимальное количество чисел, которые должны присутствовать в пароле. Если это невозможно (например, если формат пароля не имеет достаточно n символов), создается исключение. Установите значение 0 без минимального значения.

Минимальные символы
MinimumSymbols integer

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Пароль обычного текста
PlainTextPassword string

Пароль в виде обычного текста при запросе. Пароль может запрашиваться в виде обычного текста, так как пароль является одноразовым паролем, предназначенным для передачи с помощью SMS или электронной почты (например), поэтому его необходимо увидеть as-is.

Создание файла запуска сеанса удаленного рабочего стола (RDS)

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

Параметры

Имя Ключ Обязательно Тип Описание
Удаленный адрес
RemoteAddress True string

Адрес удаленной системы для подключения. Это может быть IP-адрес, имя узла или полное доменное имя (FQDN).

Путь к выходной папке
OutputFolderPath True string

Папка, в которой нужно сохранить файл RDP.

Имя файла RDP
RDPFileName True string

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

Перезаписать RDP-файл, если он уже существует
OverwriteRDPFileIfAlreadyExists boolean

Установите значение true, чтобы автоматически перезаписать любой файл RDP с той же папкой или именем файла. Установите значение false, если новый файл RDP не должен быть создан, если существующий файл RDP с той же папкой или именем файла уже существует.

Доверять удаленному компьютеру
TrustRemoteComputer boolean

Установите значение true, чтобы пометить удаленный адрес как доверенный (в реестре Windows), в основном для целей перенаправления устройств, устраняя всплывающее окно, которое может быть получено при запуске RDP-файла.

Хранение учетных данных
StoreCredentials boolean

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

Имя пользователя
UserName string

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

Пароль
Password string

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

Тип учетных данных
CredentialType string

При хранении учетных данных для хранения сведений о проверке подлинности удаленного рабочего стола можно указать тип учетных данных: Windows или Generic. Для сохранения учетных данных RDP обычно создается учетные данные Windows.

Сохраняемость учетных данных
CredentialPersistence string

При хранении учетных данных для хранения сведений о проверке подлинности удаленных рабочих столов это позволяет указать сохраняемость учетных данных: сеанс (длится только для этого сеанса входа), LocalMachine (сохраняется для этого пользователя только на сеансах и перезагрузках только на этом компьютере) или Enterprise (может перемещаться для этого между компьютерами). Значение по умолчанию при создании файлов RDP — Session.

Перенаправление принтеров
RedirectPrinters boolean

Должны ли принтеры в локальном сеансе сопоставляться с сеансом удаленного рабочего стола? Этот параметр может быть применен в удаленном конце и, следовательно, не вступают в силу.

Перенаправление всех дисков
RedirectAllDrives boolean

Должны ли все буквы диска (например, C:) в локальном сеансе сопоставляться с сеансом удаленного рабочего стола? Этот параметр может быть применен в удаленном конце и, следовательно, не вступают в силу.

Перенаправление буфера обмена
RedirectClipboard boolean

Следует ли совместно использовать буфер обмена между локальной и удаленной системой, позволяя копировать и вставлять данные между двумя системами? Этот параметр может быть применен в удаленном конце и, следовательно, не вступают в силу.

Полноэкранный режим
Fullscreen boolean

Если сеанс удаленного рабочего стола будет полным экраном.

Ширина рабочего стола
DesktopWidth integer

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

Высота рабочего стола
DesktopHeight integer

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

Использование нескольких мониторов
UseMultiMonitor boolean

Установите значение false, если сеанс удаленного рабочего стола полноэкранного экрана должен использовать только один монитор. Установите значение true, если сеанс удаленного рабочего стола полноэкранного экрана должен использовать все мониторы. Не влияет на систему с одним монитором (и, следовательно, большинство виртуальных машин).

Глубина цвета сеанса
SessionBPP integer

Глубина цвета сеанса удаленного рабочего стола в битах на пиксель (BPP). Более высокое число приводит к большему количеству цветов. Поддерживаемые значения: 15, 16, 24, 32.

Интеллектуальный размер
SmartSizing boolean

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Путь к файлу RDP
RDPFilePath string

Полный путь к созданному RDP-файлу.

Создать каталог

Создает каталог (папку) на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к каталогу
DirectoryPath True string

Полный путь к каталогу (папке). Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Ошибка, если уже существует
ErrorIfAlreadyExists boolean

Следует ли IA-Connect вызвать ошибку, если каталог (папка) уже существует?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Сохранение активности сеанса

Сохраняет сеанс пользователя агента IA-Connect, перемещая мышь в указанный интервал, чтобы предотвратить простой сеанс.

Параметры

Имя Ключ Обязательно Тип Описание
X wiggle
XWiggle integer

Количество пикселей для перемещения мыши по горизонтали.

Y wiggle
YWiggle integer

Количество пикселей для перемещения мыши по вертикали.

Задержка wiggle в секундах
WiggleDelayInSeconds double

Количество секунд между движениями мыши при перемещении.

Порог простоя в секундах
IdleThresholdInSeconds integer

Количество секунд, которые должны пройти с момента последнего ввода перед перемещением мыши.

Период проверки простоя в секундах
IdleCheckPeriodInSeconds integer

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

Общая продолжительность выполнения в секундах
TotalKeepaliveRuntimeInSeconds integer

Общее количество секунд для сохранения сеанса в режиме активности.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
KeepSessionAliveResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Средняя кнопка мыши вверх

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

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Средняя кнопка мыши вниз

Нажимает (и не освобождает) среднюю кнопку мыши в сеансе пользователя агента IA-Connect. Чтобы освободить мышь, используйте действие вверх по средней кнопке мыши.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Средняя удерживаемая мышь

Удерживает посередине кнопку мыши в сеансе пользователя агента IA-Connect в течение указанного количества секунд.

Параметры

Имя Ключ Обязательно Тип Описание
Удерживайте секунды
SecondsToHold True double

Количество секунд, удерживаемых на средней кнопке мыши.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Средняя удерживаемая мышь в координате

Удерживает среднюю кнопку мыши по указанным координатам в сеансе пользователя агента IA-Connect в течение указанного количества секунд. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Параметры

Имя Ключ Обязательно Тип Описание
X пикселей
XCoord True integer

Значение координат X (в пикселях).

Y пикселей
YCoord True integer

Значение координаты Y (в пикселях).

Удерживайте секунды
SecondsToHold True double

Количество секунд, удерживаемых на средней кнопке мыши.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Существует ли IA-Connect сеанс по имени

Возвращает, существует ли указанный сеанс директора IA-Connect. Это сеанс, в который отправляются команды агенту IA-Connect. Имя будет известно из предыдущего действия "Присоединить".

Параметры

Имя Ключ Обязательно Тип Описание
имя сеанса IA-Connect
IAConnectSessionName True string

Имя проверяемого сеанса IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
IA-Connect сеанс существует
IAConnectSessionExists boolean

Возвращает значение true, если сеанс с указанным именем существует или значение false, если нет.

Существует ли каталог

Сообщает true или false, чтобы определить, существует ли каталог (папка) на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к каталогу
DirectoryPath True string

Полный путь к каталогу (папке). Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Каталог существует
DirectoryExists boolean

Возвращает значение true, если каталог (папка) существует или значение false, если нет.

Существует ли файл

Сообщает true или false о том, существует ли файл на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу
Filename True string

Полный путь к файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Файл существует
FileExists boolean

Возвращает значение true, если файл существует, или значение false, если нет.

Убийство всех остальных агентов IA-Connect

Убивает любые другие экземпляры агента IA-Connect, которые в настоящее время выполняются в сеансе пользователя. Это обеспечит выполнение только одного экземпляра агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Число убитых агентов
NumberOfAgentsKilled integer

Число убитых процессов агента IA-Connect.

Число агентов не удалось убить
NumberOfAgentsFailedToKill integer

Количество процессов агента IA-Connect, которые не удалось убить.

Убийство потока агента

Убивает (завершает, прерывает) поток агента. Поток агента можно использовать для выполнения определенных действий в потоке, что позволяет выполнять действия в течение длительного времени (дольше времени ожидания RPA) или выполняться параллельно с другими действиями. Поток агента не удаляется (используйте действие "Удалить поток агента" для удаления потоков), чтобы разрешить любым процессам или потокам мониторинга потока агента получать ошибку "IA-Connect агент был прерван".

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор потока
ThreadId True integer

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
KillAgentThreadResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Убийство сеанса IA-Connect по имени

Убивает указанный сеанс директора IA-Connect, если он существует. Это сеанс, в который отправляются команды агенту IA-Connect. Имя будет известно из предыдущего действия "Присоединить".

Параметры

Имя Ключ Обязательно Тип Описание
имя сеанса IA-Connect
IAConnectSessionName True string

Имя убитого сеанса IA-Connect.

Присоединение к сеансу уровня 1 IA-Connect при успешном выполнении
AttachToTier1IAConnectSessionOnSuccess boolean

Следует ли IA-Connect подключиться к сеансу уровня 1 IA-Connect (сеанс директора IA-Connect, получающего сообщения SOAP и /или REST), если сеанс успешно закрыт?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
IA-Connect сеанс убит
IAConnectSessionKilled boolean

Возвращает значение true, если сеанс с указанным именем был убит или false, если нет.

Имя сеанса подключенного уровня 1 IA-Connect
AttachedTier1IAConnectSessionName string

Имя сеанса уровня 1 IA-Connect, к которому был подключен.

Удаление задачи автоматизации Orchestrator

Удалите задачу автоматизации Orchestrator, которая была отложена.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор задачи
TaskId True integer

Идентификатор задачи автоматизации Orchestrator для удаления.

Обновление исходной системы
UpdateSourceSystem boolean

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

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
TasksDeleteTaskResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Удаление операции автоматизации Orchestrator

Удалите определенную задачу автоматизации Orchestrator, указав уникальный идентификатор операции задачи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор операции
OperationId True string

Идентификатор операции задачи Orchestrator для удаления.

Обновление исходной системы
UpdateSourceSystem boolean

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

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
TasksDeleteTaskOperationResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Удаление пароля в памяти агента

Удалите пароль, хранящийся в памяти агента, или удалите все сохраненные пароли агента.

Параметры

Имя Ключ Обязательно Тип Описание
Удаление всех паролей
DeleteAllPasswords boolean

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

Идентификатор
Identifier string

Уникальный идентификатор для удаления пароля. Например: SAPGUILogon.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
DeletePasswordInAgentMemoryResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Удаление потока агента

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор потока
ThreadId integer

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

Удаление всех потоков агента
DeleteAllAgentThreads boolean

Задайте значение true, чтобы удалить все потоки агента. Установите значение false (значение по умолчанию), чтобы удалить один поток агента, указанный входными данными Thread Id.

Вызов исключения, если поток агента не удаляется
RaiseExceptionIfAgentThreadFailsToDelete boolean

Задайте значение true, чтобы вызвать исключение, если поток агента не удается удалить. Обратите внимание, что это может привести к возникновению исключения, если поток агента завершается при выполнении этого действия (так как он больше не будет существовать в точке удаления). Установите значение false (по умолчанию), чтобы игнорировать ошибки при удалении потоков агента. Выходные данные "Число удаленных потоков агента" сообщают, сколько потоков агента было удалено.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Число удаленных потоков агента
NumberOfAgentThreadsDeleted integer

Если значение "Удалить все потоки агента" имеет значение true, это выходные данные будут содержать количество удаленных потоков агента (0 или выше). Если значение "Удалить все потоки агента" имеет значение false, а идентификатор потока агента указан, этот результат будет иметь значение 0 или 1.

Удаление удостоверения из системы безопасности папок

Удаляет удостоверение (например, пользователя, группы или компьютера) из разрешений безопасности на папке на компьютере, где выполняется агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к папке
FolderPath True string

Полный путь к папке. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Удостоверение для удаления
IdentityToRemove True string

Удостоверение пользователя или группы, которые необходимо удалить. Это может быть в форме "имя пользователя", "ДОМЕН\имя_пользователя" или "username@domainfqdn".

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Разрешение было удалено
PermissionWasRemoved boolean

Возвращает значение true, если разрешение было успешно удалено.

Удаление удостоверения из системы безопасности файлов

Удаляет удостоверение (например, пользователя, группы или компьютера) из разрешений безопасности на файле на компьютере, где запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу
FilePath True string

Полный путь к файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Удостоверение для удаления
IdentityToRemove True string

Удостоверение пользователя или группы, которые необходимо удалить. Это может быть в форме "имя пользователя", "ДОМЕН\имя_пользователя" или "username@domainfqdn".

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Разрешение было удалено
PermissionWasRemoved boolean

Возвращает значение true, если разрешение было успешно удалено.

Удаление файлов

Удаляет файлы в указанной папке, соответствующей шаблону на компьютере, где выполняется агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к каталогу
DirectoryPath True string

Полный путь к каталогу (папке). Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рисунок
Pattern string

Шаблон для удаления файлов , например для всех файлов или *.txt для файлов с расширением .txt.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Количество удаленных файлов
NumberOfFilesDeleted integer

Количество успешно удаленных файлов.

Количество файлов, которые не удалось удалить
NumberOfFilesFailedToDelete integer

Количество файлов, которые не удалось удалить.

Удаленный сеанс выхода

Регистрирует удаленный сеанс, в котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Секунды ожидания
SecondsToWait integer

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Удалить каталог

Удаляет каталог (папку) на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к каталогу
DirectoryPath True string

Полный путь к каталогу (папке). Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рекурсивный
Recursive boolean

Следует ли удалять вложенные каталоги (вложенные папки) и файлы в каталоге?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Удалить файл

Удаляет файл на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу
Filename True string

Полный путь к файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Удаляет учетные данные пользователя

Удаляет учетные данные в профиле пользователя в сеансе агента IA-Connect. Учетные данные можно просмотреть на панели управления Windows.

Параметры

Имя Ключ Обязательно Тип Описание
Адрес учетных данных
CredentialAddress True string

Имя или адрес учетных данных.

Тип учетных данных
CredentialType True string

Тип учетных данных: Windows или Generic.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
CredentialDeleteResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Удерживайте указатель мыши правой кнопкой мыши

Удерживает правую кнопку мыши в сеансе пользователя агента IA-Connect в течение указанного количества секунд.

Параметры

Имя Ключ Обязательно Тип Описание
Удерживайте секунды
SecondsToHold True double

Количество секунд, удерживаемых на правой кнопке мыши.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Удерживайте указатель мыши правой кнопкой мыши в координате

Удерживает правую кнопку мыши по указанным координатам в сеансе пользователя агента IA-Connect в течение указанного количества секунд. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Параметры

Имя Ключ Обязательно Тип Описание
X пикселей
XCoord True integer

Значение координат X (в пикселях).

Y пикселей
YCoord True integer

Значение координаты Y (в пикселях).

Удерживайте секунды
SecondsToHold True double

Количество секунд, удерживаемых на правой кнопке мыши.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Установка владельца в папке

Задает владельца папки на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к папке
FolderPath True string

Полный путь к папке. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Удостоверение пользователя
UserIdentity True string

Удостоверение пользователя, назначаемого владельцем. Это может быть в форме "имя пользователя", "ДОМЕН\имя_пользователя" или "username@domainfqdn".

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Установка владельца в файле

Задает владельца файла на компьютере, на котором запущен агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу
FilePath True string

Полный путь к файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Удостоверение пользователя
UserIdentity True string

Удостоверение пользователя, назначаемого владельцем. Это может быть в форме "имя пользователя", "ДОМЕН\имя_пользователя" или "username@domainfqdn".

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Установка времени ожидания команды агента IA-Connect

Задает время ожидания команды, которое будет использоваться агентом IA-Connect для каждой выполняемой команды.

Параметры

Имя Ключ Обязательно Тип Описание
Время ожидания команды в секундах
CommandTimeoutInSeconds True integer

Время ожидания команды, которое будет использовать агент IA-Connect. При чтении или записи больших объемов данных может потребоваться увеличить период ожидания.

Завершение потоков команд RPA времени ожидания
TerminateTimedoutRPACommandThreads boolean

Следует ли завершить поток команды, если истекло время ожидания?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Установка метода перемещения мыши

Задает текущий метод перемещения мыши на mouse_event или setcursorpos.

Параметры

Имя Ключ Обязательно Тип Описание
Установка метода перемещения мыши
MouseMoveMethod True string

Укажите метод перемещения мыши (mouse_event или setcursorpos).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Установка положения курсора мыши

Задает курсор мыши в сеансе пользователя агента IA-Connect указанной позиции. API setcursorpos используется для перемещения мыши независимо от выбранного API активного перемещения мыши.

Параметры

Имя Ключ Обязательно Тип Описание
X пикселей
X True integer

Значение координат X (в пикселях).

Y пикселей
Y True integer

Значение координаты Y (в пикселях).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Установка принтера по умолчанию

Задает принтер по умолчанию для пользователя в сеансе агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Имя принтера по умолчанию
DefaultPrinterName True string

Имя принтера по умолчанию для пользователя.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Установка самого верхнего графического интерфейса агента IA-Connect

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

Параметры

Имя Ключ Обязательно Тип Описание
Самый верхний
TopMost boolean

Следует ли установить самый верхний (true) агент IA-Connect или должен быть отключен (false)?

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Установка умножения мыши

Задает глобальный умножитель мыши в сеансе пользователя агента IA-Connect. Это может быть полезно во время разработки, если возникают проблемы с масштабированием удаленного рабочего стола.

Параметры

Имя Ключ Обязательно Тип Описание
Умножение X
MouseXMultiplier double

Глобальный умножитель глобальной мыши по горизонтали (X) для задания (для при перемещении агента мыши). Умножение действует только в том случае, если отключена функция мультиметрии.

Умножение Y
MouseYMultiplier double

Глобальный умножитель глобальной мыши (Y) для задания (для при перемещении агента мыши). Умножение действует только в том случае, если отключена функция мультиметрии.

Применимо к mouse_event
ApplyToMouseEvent boolean

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

Применение к SetCursorPos
ApplyToSetCursorPos boolean

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

Применение к текущему методу перемещения мыши
ApplyToCurrentMouseMoveMethod boolean

Этот аргумент указывает, следует ли применять глобальные значения умножения мыши к текущему методу перемещения мыши (например, если SetCursorPos является текущим методом перемещения мыши, умножение будет применяться к SetCursorPos). Если задано значение true, входные данные "Применить к mouse_event" и "Применить к SetCursorPos" игнорируются.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Хранение пароля в памяти агента

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
Identifier True string

Уникальный идентификатор пароля. Если идентификатор уже используется, он будет перезаписан. Например: SAPGUILogon. Пароли извлекаются с помощью фразы {IAConnectPassword:Identifier}.

Пароль
Password True password

Пароль для хранения.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Результат команды
StorePasswordInAgentMemoryResult boolean

Результат команды (успешное выполнение или сбой).

Сообщение об ошибке
ErrorMessage string

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

Чтение всего текста из файла

Считывает текстовое содержимое файла на компьютере, где выполняется агент IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Путь к файлу
Filename True string

Полный путь к файлу. Это должно быть доступно из сеанса, в котором запущен агент IA-Connect.

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Содержимое текста файла
FileTextContents string

Текстовое содержимое файла.

Чтение с учетных данных пользователя

Считывает имя пользователя и пароль из учетных данных в профиле пользователя в сеансе агента IA-Connect. Учетные данные можно просмотреть на панели управления Windows. Имя пользователя и пароль можно получить из универсальных учетных данных, а только имя пользователя можно получить из учетных данных Windows.

Параметры

Имя Ключ Обязательно Тип Описание
Адрес учетных данных
CredentialAddress True string

Имя или адрес учетных данных.

Тип учетных данных
CredentialType True string

Тип учетных данных: Windows или Generic.

Симметричный ключ шифрования
SymmetricKey string

Необязательный симметричный ключ шифрования, используемый для расшифровки пароля учетных данных (используйте, если учетные данные были зашифрованы с помощью ключа). Использовать только универсальные учетные данные, так как пароль для учетных данных Windows не может быть извлечен.

Хранение пароля в качестве идентификатора
StorePasswordAsIdentifier string

Если указан идентификатор, полученный пароль учетных данных будет храниться в агенте для последующего получения или использования любыми командами, которые могут использовать сохраненные учетные данные. Эти пароли хранятся только в памяти и теряются при закрытии агента. Использовать только универсальные учетные данные, так как пароль для учетных данных Windows не может быть извлечен. Например: MyExchangePassword.

Не возвращайте пароль
DontReturnPassword boolean

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

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Возвращаемое значение

Имя Путь Тип Описание
Имя пользователя
UserName string

Имя пользователя учетных данных.

Пароль
Password string

Пароль учетных данных.

Щелкните левую кнопку мыши

Нажмите левую кнопку мыши в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Щелкните левую кнопку мыши в координате

Нажмите левую кнопку мыши в сеансе пользователя агента IA-Connect по указанным координатам. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Параметры

Имя Ключ Обязательно Тип Описание
X пикселей
XCoord True integer

Значение координат X (в пикселях).

Y пикселей
YCoord True integer

Значение координаты Y (в пикселях).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Щелкните правой кнопкой мыши

Щелкните правую кнопку мыши в сеансе пользователя агента IA-Connect.

Параметры

Имя Ключ Обязательно Тип Описание
Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()

Щелкните правой кнопкой мыши по координате

Щелкните правую кнопку мыши в сеансе пользователя агента IA-Connect по указанным координатам. В настоящее время активный API перемещения мыши (mouse_event или setcursorpos) используется для перемещения мыши. Масштабирование DPI и несколько дисплеев учитываются при вычислении координат.

Параметры

Имя Ключ Обязательно Тип Описание
X пикселей
XCoord True integer

Значение координат X (в пикселях).

Y пикселей
YCoord True integer

Значение координаты Y (в пикселях).

Рабочий процесс
Workflow True string

Добавьте следующее выражение здесь: workflow()