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

Модуль оркестратор предназначен для настройки взаимосвязей между следующими сущностями: Компьютеры, Сценарии, Роботы, Расписания.

• Компьютеры – это персональные компьютеры, сервера на которых будут исполняться сценарии по заданным расписаниям.
• Сценарии – xml файлы, содержащие скрипт с действиями, которые выполняет робот.
• Роботы – контейнер, в котором устанавливается взаимосвязь между Компьютером, сценариями, исполняемыми на данном устройстве и расписаниями, по которым данные сценарии исполняются.
• Расписания – расписание запуска сценариев

Взаимосвязи:

Один Робот может быть связан только с одним Компьютером.
Один Робот может содержать несколько Расписаний.
Одно Расписание может запускать несколько Сценариев.
Рис. 56 Взаимосвязи
Запуск модуля оркестратор
Для входа в Оркестратор необходимо указать в браузере http://localhost:11001/agents (это путь где по умолчанию установлен оркестратор) или через меню «Пуск» или через ярлык на рабочем столе.
При успешном выполнении операций отображается начальная страница Оркестратора.
Главная страница
Описание интерфейса
В верхней части страницы расположены управляющие элементы:

• Кнопка вызова раскрывающегося меню (крайняя левая кнопка)
• Переход в PF
• Лицензия
• Выбор языка интерфейса
• Информация о версии ПО

Кнопка вызова раскрывающегося меню навигации:

• Профиль (разворачивает дополнительное меню управления пользователем в меню навигации)
• Роботы
• Журнал действий
• Управление доступом
• Установка прав
• Регистрация лицензии
• Очереди
Меню навигации
Кнопка «Лицензия» переназначена для просмотра текущего состояния лицензии и активации новой. (Подробное описание функционала в разделе «Активация лицензии»)
Рис. 59 Закладки
Раздел «Профиль»
Работа в Оркестраторе подразумевает его многопользовательское использование. Несколько пользователей могут контролировать работу одного робота, кроме этого, один пользователь может контролировать работу нескольких роботов. Для работы в многопользовательском режиме необходимо создать учетные записи пользователей и настроить доступ пользователей по ролям (подробно про настройку ролей см. раздел «Управление ролями»).

Чтобы создать нового пользователя следуйте инструкции:

1.Нажмите на левую верхнюю кнопку, чтобы вызвать раскрывающееся меню.
Раскрывающееся меню на левой верхней кнопке
2. В раскрывшемся меню нажмите на кнопку «Профиль»
Кнопка "Профиль" слева сверху в выпадающем меню
3.Нажмите на кнопку «Создать аккаунт» для создания новой учетной записи.
Кнопка "Создать аккаунт" на левой верхней панели
4. Система отобразит форму регистрации нового пользователя (рис. 5.2.1.4). Администратор должен ввести имя пользователя и пароль требуемой сложности или сгенерировать пароль автоматически с помощью нажатия на пиктограмму «кости». После заполнения всех обязательных полей нажмите на кнопку «Создать аккаунт».
Окно создания нового аккаунта
Раздел «Роботы»
В данном разделе отображается список роботов (карточки роботов), где для каждого робота указан статус, переключатель включения/выключения робота, информация и блок управления (если карточка развёрнута).
Робот (Карточка робота)
В карточке робота располагается информация по выбранному роботу:

• Наименование робота
• Статус
• Наименование Компьютера
• IP Адрес компьютера
• Описание

В нижней части карточки робота расположены кнопки (управляющие элементы):

• Подтверждение регистрации
• Ручной запуск скрипта
• Редактировать
• Добавить расписание

Параметры робота
Рис. 61 Параметры робота
Сценарии
Для открытия экранной формы «Сценарии» необходимо нажать на соответствующую кнопку
В данном разделе отображается Сценарии доступные для запуска
Добавление сценария
Сценарии добавляются в оркестратор вручную по нажатию на кнопку «Импортировать» в правой верхней части экрана.
Редактирование Робота
Карточка робота в окне оркестратора
  1. Для редактирования параметров робота необходимо с помощью переключателя перевести его в состояние выключен
2. Нажать на кнопку редактировать
Система выведет окно с информацией о роботе
Информационное окно робота
Функционал редактирования позволяет изменить:

1. Имя робота;
2. Имя компьютера пользователя, привязанного к данному роботу;
3. IP-адрес
4. Добавить или изменить описание робота
5. Получить информацию об актуальных расписаниях данного робота. А также удалить расписание.

Удаление Робота

1. Удалять возможно Роботы только в состояние выключен
2. Нажать на кнопку редактировать
3. Для удаления необходимо нажать на кнопку «Удалить»

Ручной запуск сценария

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

Добавить Расписание

1. Нажать на кнопку добавить расписание.
Создание Задачи
2.Необходимо заполнить нижеуказанные данные и нажать на кнопку «Сохранить».

- Имя Задачи – имя для данного расписания
- Тип запуска – тип запуска расписания.
- Начало – дата и время начала запуска расписания.
- Окончание – дата и время окончания запуска расписания.
- Зависимое выполнение – данный флаг нужен, если в расписании добавлено более 1 скрипта, при установке флага проверяется следующее условие: если в первом скрипте будет ошибка, выполнение второго скрипта не начнется.
- Проводить повторный запуск скриптов при ошибке – данный флаг устанавливается при необходимости производить перезапуск скрипта, если он завершился с ошибкой.

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

1)Тип запуска: «Однократно»
Тип запуска: Однократно
2) Тип запуска: Ежедневно.
Рис. 68 Тип запуска: Ежедневно
Кроме общих параметров, для данного типа запуска и для типов запуска ниже появляются дополнительные параметры:

·Интервал – промежуток времени, через который скрипт будет запускаться снова.
·Срабатывание с/по: время начала и окончания работы сценария в течение дня.

3)Тип запуска: «Еженедельно»
Тип запуска: Еженедельно
4) Тип запуска: Ежемесячно.
Тип запуска: Ежемесячно
5) Нажать на кнопку сохранить задачу
6) После этого в открывшемся окне необходимо выбрать Сценарий или несколько Сценариев и нажать на кнопку «Добавить».
Добавление сценария

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

Удаление Расписания

  1. Удаление Сценария из Расписания возможно только в Роботах, которые находятся в состоянии выключен
2. Нажать на кнопку редактировать
3. Для удаления необходимо нажать на кнопку «Удалить»

Удаление Сценария из Расписания

  1. Удаление Сценария из Расписания возможно только в Роботах, которые находятся в состоянии выключен
2. Необходимо перейти на вкладку «Расписание» нажать на кнопку редактировать
Вкладка Расписание
3. Выделить необходимое расписание и нажать на кнопку удаления.

Расписание
4. Для удаления необходимо нажать на кнопку «Удалить»

5. В открывшемся диалоговом окне подтвердить удаление, нажав на кнопку «Да»

Раздел «Журнал Действий»
В данном разделе отображается история запуска и выполнения Сценариев
Журнал
Для просмотра подробной информации по выполнению Сценария необходимо нажать на кнопку в правой части раздела. Логирование работы скриптов ведется в таблицу БД. История доступна через интерфейс в оркестраторе, а также посредством API. Логирование системных ошибок по умолчанию ведется в файл, но гибко настраивается конфигуратором для разных потребителей от UDP до базы данных или отдельно файла.
Управление ролями
Для обеспечения эффективного и безопасного управления роботами работа в модуле Оркестратор основана на использовании ролевой модели.

Интерфейс управления ролевой моделью находится в разделе "Управление ролями". Доступ в этот раздел реализован через вызов бокового меню.

Ролевая политика Оркестратора подразумевает управлением доступом к методам и сущностям Оркестратора для пользователя Оркестратора и к сущностям Оркестратора для робота.

Сущностями Оркестратора являются сценарии робота и элементы очередей. К методам Оркестратора относится управление агентами, переменными и функционалом очередей.


1. Наведите курсор на кнопку выпадающего меню, находящуюся слева сверху на панели Оркестратора.

Выпадающее меню левого бокового меню
2. Нажмите на кнопку чтобы перейти в интерфейс управления ролевой политикой.
Выпадающее меню левого бокового меню
Роли
Функционал создания и редактирования ролей, а также управление политикой доступа ролей к методам Оркестратора находится на интерфейсе вкладки «Роли» раздела «Управления ролями».
Основное предназначение функционала Ролей в разграничении доступа различных групп пользователей к методам оркестратора для обеспечения безопасности и стабильности работы сценариев робота.
Интерфейс вкладки "Роли"
Нажмите на кнопку чтобы создать новую роль. Задайте имя новой роли в поле
Выберите необходимые методы Оркестратора, которые будут доступны данной роли и нажмите на кнопку «Создать роль» чтобы завершить создание роли.
В случае успешного создания роли на левой боковой панели со списком ролей будет отражена вновь созданная роль. Справой стороны отображаются все доступные методы для этой роли. Повторное нажатие на чекбокс метода снимает выделение для этого метода и закрывает доступ этой роли для этого метода.
Окно управления методами оркестратора и сущностями
Чтобы удалить роль, выберете необходимую роль из списка ролей и нажмите на кнопку удаления роли.
Пользователи
Функционал назначения пользователю той или иной роли находится на интерфейсе вкладки раздела «Управления ролями». Основное предназначение данного функционала - обеспечение ролевой политики посредством присваивания пользователю Ролей. Таким образом происходит разграничивание степеней влияния групп пользователей на функционал работы Оркестратора и Студии.
Обратите внимание, говоря о пользователе, мы подразумеваем профиль (аккаунт), созданный на Оркестраторе. При первом входе создаётся пользователь (профиль) с root правами. Т.е. по умолчанию этому аккаунту доступны все методы и сущности.
Пример присваивание ролей пользователю показан на рисунке. При необходимости нажмите на кнопку, чтобы посмотреть доступные этой роли методы.
Note: при назначении пользователю нескольких ролей, конечный пул доступных методов будет представлять объединение доступных методов всех назначенных пользователю ролей. Таким образом, если пользователю назначена одна роль с доступом только к первой половине всех методов, и вторая роль с доступом только ко второй половине всех методов. В результате объединения этих ролей пользователю будут доступны все методы Оркестратора.
Роботы
Функционал назначения роботу той или иной роли находится на интерфейсе вкладки раздела «Управления ролями». Основное предназначение данного функционала - обеспечение безопасности и стабильности работы сценариев, посредством присваивания роботу Ролей. Таким образом происходит изоляция критически важных сценариев и переменных от общего доступа другими роботами.
Пример присваивание ролей роботу показан на рисунке. При необходимости нажмите на кнопку, чтобы посмотреть доступные этой роли методы.
Note: при назначении роботу нескольких ролей, конечный пул доступных методов будет представлять объединение доступных методов всех назначенных роботу ролей. Таким образом, если роботу назначена одна роль с доступом ко всем методам, и вторая роль без доступа ко всем методам. В результате объединения этих ролей роботу будут доступны все методы Оркестратора.
Предоставление доступа
После того как Роли распределены между пользователями системы, пользователям необходимо предоставить "инструменты" работы.
Интерфейс, обеспечивающий управление предоставлением доступов, находится в разделе "Предоставление доступа". Доступ в этот раздел реализован через вызов бокового меню.
Функционал управления доступом подразумевает разграничение политик изменения и использования пользователей, переменных, роботов и сценариев доступов друг к другу.

1. Наведите курсор на кнопку выпадающего меню, находящуюся слева сверху на панели Оркестратора.
2. Нажмите на кнопку чтобы перейти к интерфейсу управления предоставления доступов.
Выпадающее меню левого бокового меню
Доступ пользователей к роботам
Функционал присваивания пользователю доступа к тому или иному роботу находится на интерфейсе вкладки «Доступ пользователей к роботам» раздела «Предоставление доступа».
Роботы по умолчанию создаются в режиме "Приватный". То есть роботы, созданные конкретным пользователем (аккаунтом) Оркестратора, доступны только ему. Для предоставления другому пользователю (аккаунту) Оркестратора доступа к своему роботу реализован данный функционал.

Пример присваивания доступа к роботу "Мой робот!", созданного аккаунтом (a.yamoldin), стороннему пользователю с ограниченными правами.
Результатом данного действия будет появление в списке роботов у пользователя (аккаунта) Оркестратора под именем "Пользователь ограниченного доступа" робота под названием "Мой робот!".
Доступ ролей к переменным
Функционал создания и управления доступом Ролей к глобальным переменным находится на интерфейсе вкладки раздела «Предоставление доступа».
Чтобы создать глобальную переменную нажмите на кнопку «Создать» и заполните необходимые поля.
По умолчанию глобальная переменная создаётся в режиме «Общедоступная». То есть видимость этой переменной будет у всех пользователей, обладающих разрешениями на просмотр глобальных переменных в их Роли (вне зависимости от того, какие разрешения выставлены в правом окне «Список ролей»).
Чтобы удалить глобальную переменную нажмите на кнопку
Для редактирования глобальной переменной нажмите на кнопку. Свойство приватности глобальной переменной возможно установить только с помощью функционала редактирования глобальной переменной.
При назначении переменной свойства приватный область её видимости определяется исключительно разрешениями правого окна «Список ролей».
Доступ ролей к переменным
Функционал создания и управления доступом пользователей (профилей) Оркестратора к глобальным переменным находится на интерфейсе вкладки раздела «Предоставление доступа».
Чтобы создать глобальную переменную нажмите на кнопку «Создать» и заполните необходимые поля.
По умолчанию глобальная переменная создаётся в режиме «Общедоступная». То есть видимость этой переменной будет у всех пользователей, обладающих разрешениями на просмотр глобальных переменных в их Роли (вне зависимости от того, какие разрешения выставлены в правом окне «Список пользователей»).
Чтобы удалить глобальную переменную нажмите на кнопку
Для редактирования глобальной переменной нажмите на кнопку . Свойство приватности глобальной переменной возможно установить только с помощью функционала редактирования глобальной переменной.

При назначении переменной свойства приватный область её видимости определяется исключительно разрешениями правого окна «Список пользователей». Т.е. глобальные переменные будут доступны только тем пользователям (профилям) Оркестратора, которые отмечены в списке. Но не будут доступны роботам.
Доступ роботов к переменным
Функционал создания и управления доступом роботов к глобальным переменным находится на интерфейсе вкладки «Доступ роботов к переменным» раздела «Предоставление доступа».
Чтобы создать глобальную переменную нажмите на кнопку «Создать» и заполните необходимые поля.
По умолчанию глобальная переменная создаётся в режиме «Общедоступная». То есть видимость этой переменной будет у всех роботов, обладающих разрешениями на просмотр глобальных переменных в их Роли (вне зависимости от того, какие разрешения выставлены в правом окне «Список агентов»).
Чтобы удалить глобальную переменную нажмите на кнопку.
Для редактирования глобальной переменной нажмите на кнопку . Свойство приватности глобальной переменной возможно установить только с помощью функционала редактирования глобальной переменной.

При назначении переменной свойства приватный область её видимости определяется исключительно разрешениями правого окна «Список агентов». Т.е. глобальные переменные будут доступны только тем роботам, которые отмечены в списке. Но не будут доступны пользователям (профилям) Оркестратора.
Доступ пользователей к сценариям
Функционал управления доступом пользователей к сценариям (скриптам) робота, находящимся в Оркестраторе, располагается на интерфейсе вкладки «Доступ пользователей к сценариям» раздела «Предоставление доступа».
По умолчанию сценарии импортируются в оркестратор в режиме «Общедоступный». То есть видимость импортируемого сценария будет у всех пользователей (профилей) Оркестратора, обладающих разрешениями на просмотр сценариев в их Роли (вне зависимости от того, какие разрешения выставлены в левом окне «Список пользователей»).
При назначении сценарию свойства приватный область его видимости определяется исключительно разрешениями левого окна "Список пользователей". Т.е. сценарии (скрипты) робота будут доступны только тем пользователям, которые отмечены в списке. Сценарии (скрипты) робота всегда доступны создателю. Т.е. если сценарий загружен в Оркестратор с помощью робота, то этот сценарий будет доступен этому роботу вне зависимости от настроек ограничения доступа. Если сценарий загружен в Оркестратор с помощью функционала импортирования сценариев (скриптов) конкретным пользователем, то данный сценарий (скрипт) будет доступен этому пользователю вне зависимости от настроек ограничения доступа.
Доступ агентов к сценариям
Функционал управления доступом роботов (агентов) к сценариям (скриптам) робота, находящимся в Оркестраторе, располагается на интерфейсе вкладки «Доступ агентов к сценариям» раздела «Предоставление доступа»
Функционал управления доступом роботов (агентов) к сценариям (скриптам) робота, находящимся в Оркестраторе, располагается на интерфейсе вкладки «Доступ агентов к сценариям» раздела «Предоставление доступа»
По умолчанию сценарии импортируются в оркестратор в режиме «Общедоступный». То есть видимость импортируемого сценария будет у всех роботов (агентов) Оркестратора, обладающих разрешениями на просмотр сценариев в их Роли (вне зависимости от того, какие разрешения выставлены в левом окне «Список агентов (роботов)»).
При назначении сценарию свойства приватный область его видимости определяется исключительно разрешениями левого окна «Список агентов (роботов)». Т.е. сценарии (скрипты) робота будут доступны только тем роботам (агентам), которые отмечены в списке.

Сценарии (скрипты) робота всегда доступны создателю. Т.е. если сценарий загружен в Оркестратор с помощью робота, то этот сценарий будет доступен этому роботу вне зависимости от настроек ограничения доступа. Если сценарий загружен в Оркестратор с помощью функционала импортирования сценариев (скриптов) конкретным пользователем, то данный сценарий (скрипт) будет доступен этому пользователю вне зависимости от настроек ограничения доступа.
Подтверждение роботов
Функционал подтверждения роботов, находящихся в Оркестраторе, располагается на интерфейсе вкладки раздела «Предоставление доступа». Данный функционал создан для активизации робота (агента) для успешной дальнейшей работы.
Раздел «Регистрация лицензии»
Функционал регистрации лицензии находится в разделе «Предоставление лицензии».
Нажмите на кнопку и сгенерируйте первичный ключ. После генерации первичный ключ будет автоматически скопирован в буфер обмена. Отправьте первичный ключ сотруднику CSBI, курирующему ваш проект. Ответным письмом сотрудник CSBI пришлёт ключ лицензии. Вставьте полученный ключ в поле лицензия.
Доступ ролей к переменным
В данном разделе происходит управление работой функционала очередей. Главная страница раздела очередей представлена на рисунке.
Если очередь уже существует, нажмите на очередь (слева), в правом окне появится список элементов очередей. Нажмите на элемент очереди для получения дополнительной информации об ошибках и предупреждениях для этого элемента. Доступная информация:

• «Время создания» - время создания элемента очереди;

• «Текущий статус» - текущий статус элемента очереди;

• «Время старта» - время начала выполнения агентом элемента очереди;

• «Время завершения» - время окончания выполнения агентом элемента очереди;

• «Время исполнения» - фактическое время выполнения агентом элемента очереди;

• «SLA» - аналитическое время выполнения агентом элемента очереди;

• «Нарушение установленного времени» - укажет, если фактическое время выполнения сценария превысит SLA;

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

В открывшемся окне заполните поля «Имя очереди», чтобы озаглавить очередь и «Приоритет», чтобы приоритезировать очередь.
Обратите внимание, что приоритетность очередей идёт по возрастанию. Т. е. чем ниже значение поля «Приоритет», тем выше фактический приоритет на выполнение (элемент с наивысшим приоритетом на исполнение имеет нулевое значение поля «Приоритет»).
Шкала приоритезации очередей
Флаг приватности устанавливает ограничения на просмотр и изменения данной очереди. Ограничения не распространяются на владельца очереди, а также на привилегированных пользователей и пользователей, добавленных к роли, имеющей доступ к данной приватной очереди.
Нажмите на кнопку «Создать очередь» чтобы завершить создание очереди. По умолчанию очередь будет создана в состоянии «Неактивна». Чтобы активировать очередь передвиньте ползунок поля «Включена» в состояние ON.
Шкала приоритезации очередей
Активация элемента очереди
Редактировать очередь
Для редактирования очереди наведите курсор на интересующую очередь и нажмите на всплывающую кнопку редактирования очереди.
Откроется окно редактирования очереди.
Окно редактирования очереди
В открывшемся окне введите новые параметры очереди и нажмите на кнопку «Сохранить изменения».
Нажмите на кнопку для удаления очереди.
Ползунок отвечает за включение и выключение очереди.
Информация об элементе очереди
Из главного окна перейдите на вкладку «Активные элементы на агенте» чтобы получить информацию о том, на каком агенте, в какой очереди и какой элемент выполняется.
Информационное окно активных элементов на роботе
Чтобы вручную остановить текущее элемента очереди, наведите курсор на агента, выполняющего в данный момент элемент очереди и нажмите кнопку «Остановить выполнение».
Ручная остановка выполнения элемента очереди
Управление очередями для агентов
На вкладке «Список очередей для роботов» происходит управление очередями для агентов. Общий вид страницы представлен на рис.
Общий вид страницы «Список очередей для роботов»
В левой части расположен список агентов. Кликните на агента для получения информации о связанных с ним очередях.
Если очередь не добавлена к агенту, это можно сделать вручную.
Чтобы связать очередь с агентом нажмите на кнопку «Выбрать очередь» в правом верхнем углу экрана.
Откроется форма добавления очереди со списком доступных для добавления очередей
Форма добавления очереди к агенту
Нажмите на кнопку «Добавить» , выбрав необходимую очередь, чтобы добавить очередь к агенту
Для удаления очереди из агента наведите курсор на очередь и нажмите на кнопку.
Управление агентами для очередей
На вкладке «Список агентов для очередей» происходит управление агентами для очередей. Общий вид страницы представлен на рис.
Общий вид страницы «Список роботов для очередей»
В левой части расположен список очередей. Кликните на очередь для получения информации о подключенных к ней агентах.
Если агент не добавлен к очереди, это можно сделать вручную.

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