Api оркестратор что это

Почему крупные компании пользуются несколькими банками, или Как уместить десятки окон в одно с помощью API

Мультибанковская платформа для интеграции с SAP позволяет легко взаимодействовать в одном окне не только с нашим банком, но и с десятками других через открытые API. Такой пока нет нигде в мире — и мы ее разработали.

Сегодня корпоративные клиенты банков хотят получать такой же уровень сервиса, как и физические лица: управлять своими финансами в реальном времени, с помощью цифровых инструментов и с минимальным количеством шагов для каждого действия — даже если речь идет о продуктах нескольких банков. Это подталкивает банки к экспериментам, а иногда и абсолютным инновациям — такой стала наша мультибанковская платформа для системы управления предприятиями SAP. Мы научились объединять на ней услуги разных банков (никакой конкуренции, только взаимная выгода!), и делать когда-то сложные операции простыми, понятными и быстрыми.

Недискриминационная мультибанковская платформа

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

Так что управлять финансовыми продуктами разных банков – выставлять и оплачивать счета, получать выписки, открывать и закрывать депозиты, обменивать валюту, управлять кредитами и так далее – компаниям приходится из разных приложений, с разным UX/UI, дизайном и функциональностью. Это долго и неудобно: казначей компании вынужден постоянно переключаться между интерфейсами, вручную переносить информацию и документы из банковских приложений в систему учета и обратно.

Решение проблемы – интеграция обслуживающих банков в ERP. Но для абсолютного большинства даже самых крупных компаний это непозволительная роскошь. Сложно, дорого и долго: выделенная специально для этой задачи команда, к примеру, из пяти технических специалистов потратит на реализацию интеграции с одним банком как минимум полгода, при этом для подключения каждого нового банка необходимо разрабатывать новую схему из-за существенных различий в организации систем и процессов.

Команда бизнес-технологий корпоративного и инвестиционного бизнеса Райффайзенбанка увидела эту проблему, когда проводила исследования для приложения Райффайзен Бизнес Онлайн, и решила разобраться с ней, разработав уникальный для рынка ИТ-продукт, который позволяет собрать все банки в одном окне учетной системы. Так как такой продукт единственный в своем роде, его разработка связана с решением абсолютно нетиповых задач.

Мультибанковская функциональность в контуре SAP станет доступна для всех корпоративных клиентов Райффайзенбанка. Открывая SAP, сотрудник увидит информацию по счетам всех банков-партнеров в одном окне, сможет провести нужные банковские операции, заказать выписку, открыть новые продукты, обменять валюту, не переходя в другое приложение – другими словами, сделать за 15 минут то, на что раньше уходили часы.

Это было наше первое знакомство с продуктами SAP. Они сильно отличаются от тех подходов и технологий, что мы привыкли видеть. По ощущениям это знакомство можно сравнить с первым шагом по неизведанной ранее планете. Главным вызовом для нас стало создание технически универсального продукта, который может работать у большинства клиентов на разных версиях SAP, в том числе на облачных платформах NEO и Cloud Foundry. При этом для нас важно было сохранить возможность расширения и добавления новых банковских продуктов или подключения других банков.

Андрей Величко, эксперт-разработчик группы разработки ПО для корпоративного и инвестиционного бизнеса Райффайзенбанка

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

SAP UI5, Fiori, бесшовный пользовательский опыт и уникальные сценарии работы

Из базовых возможностей интеграция предлагает удобное управление счетами, выписками и платежами с бесшовным, незаметным для пользователя переключением между приложениями – нашим аддоном и SAP FI. Так, заказ выписки происходит в нашем Fiori-приложении, а попадает она напрямую в SAP FI, там же хранится и доступна к просмотру. Незаметный переход был достигнут благодаря тому, что команда банка использовала для нового продукта не корпоративный UX/UI, а UI-интерфейс SAP – SAP Fiori.

У нас был выбор: разработать новый дизайн, либо приблизить его к уже знакомому пользователю интерфейсу SAP. Мы выбрали второй вариант – использовали интерфейс UI5 и сохранили неизменными все привычные пользователям SAP формы, чтобы при переходе из учетной системы в наше приложение и обратно пользовательский опыт клиента не разрывался.

Алексей Ломаев, менеджер по развитию бизнес-технологий отдела бизнес-технологий корпоративного и инвестиционного бизнеса Райффайзенбанка

Помимо базовой функциональности, приложение позволяет оформлять новые и управлять продуктами в SAP, например, размещать депозиты, с возможностью выбора подходящих параметров и условий. В приложении ERP-системы клиент может выбрать сумму, банк, срок размещения, определить время выплаты процентов. Приложение отображает динамическую процентную ставку. Остается только выбрать счет списания и счет начисления. Все, депозит размещен, не выходя из SAP.

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

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

Благодаря интеграции в SAP будут видны банковские гарантии компании. Это письменные поручительства от банков, которые нужны бизнесу, чтобы заверить поставщиков в своей благонадежности и получить возможность постоплаты, тем самым избежать кассовых разрывов и обеспечить непрерывность бизнеса. Гарантии чаще всего нужны молодым компаниям, о которых пока мало известно на рынке, чтобы заверить крупных поставщиков в своей благонадежности.

Список финансовых продуктов и сервисов, доступных в учетной системе, будет постоянно расширяться в ответ на потребности клиентов. На очереди, например, валютный контроль – один из наиболее востребованных (согласно опросу) среди наших клиентов-пользователей SAP сервис. Деньги от валютного партнера попадают не на расчетный счет компании, а на транзитный счет. Чтобы осуществить валютный контроль и получить деньги, клиенту необходимо отправить в банк до 10 документов. Среди них распоряжение о распределении с транзитного счета, подтверждающие операцию документы – контракт и дополнительные соглашения к нему, а также справка о подтверждающих документах, платежное поручение, заявление на валютный перевод и другие. Это сложный в плане интеграции продукт, который затрагивает несколько систем и требует загрузки множества документов.

Интеграция в полный рост, API и «четыре девятки»

Технически интеграция с SAP – это сложный ИТ-продукт, объединяющий под капотом множество систем.

Фронт – само Fiori-приложение, интерфейс, с которым работает клиент в своем браузере.
Функциональный модуль ABAP, который отвечает за обмен данными между Fiori-приложением и приложением SAP FI.
Отдельный Java-модуль, написанный командой банка для обработки задач, не затрагивающих фронт. К примеру, этот модуль инициирует автовыписки – каждые 15 минут автоматически, без команды пользователя, запрашивает обновленные данные по выпискам клиента, чтобы информация в приложении была всегда актуальной.
API-оркестратор, который направляет запросы во все подключенные банки, другими словами, обращается к следующей системе – продуктовым API.
Продуктовые API подготовили и открыли команды банка, например, команда депозитов, команда обмена валют и другие, чтобы клиент мог прямо из учетной системы в реальном времени совершать финансовые операции и управлять банковскими продуктами.

Продукт интегрируется с уже существующими банковскими системами, однако в самом решении нет legacy-кода – все написано с нуля.

Для обеспечения полностью независимой работы наше решение хостится сразу в двух местах – на банковской инфраструктуре и в Yandex.Cloud, которое к тому же гарантирует нам высокий уровень доступности систем – 99,99%. Кроме того, в этом облаке наша интеграция надежно защищена от DDoS-атак благодаря хорошим балансировщикам сетевой нагрузки.

Отдельно стоит отметить, что интеграция работает на всех версиях ERP-систем SAP, а их несколько: SAP ERP с множеством enchancement pack-ов, а также S/4HANA. Кроме того, в SAP есть возможность развернуть систему SAP как в локальной инфраструктуре заказчика, так и в SAP Cloud Platform, причем SAP-облаков тоже несколько – NEO и CloudFoundry.

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

Егор Пилипенко, старший разработчик группы разработки ПО для корпоративного и инвестиционного бизнеса

SAP – не единственный продукт, для которого Райффайзенбанк разрабатывает интеграцию с возможностью подключения банков-партнеров. Подобная уже реализована для учетной системы 1С посредством технологии DirectBank, а на очереди и другие популярные продукты – Microsoft Axapta, Oracle ERP.

Общие сведения о консоли Orchestration

Поддержка этой версии Orchestrator завершена. Рекомендуется выполнить обновление до Orchestrator 2022.

Консоль Orchestrator — это одна веб-страница, которая состоит из нескольких панелей и рабочих областей. В этой статье описаны эти панели и рабочие области, а также приведены процедуры для доступа к консоли и управления модулями Runbook. В ней содержатся сведения об использовании последней версии веб-консоли на основе HTML5 и использовании SilverLight (не рекомендуется). Выполните миграцию на последнюю версию веб-консоли, выполнив действия, описанные в этой статье.

Извлеките пакет выпуска версии 10.19.350.0 из DLC.

Веб-консоль Orchestrator с использованием HTML5
Веб-консоль Orchestrator с использованием SilverLight

Область навигации

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

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

Справа от области навигации отображается выбранный экран. Экран Панели мониторинга отображается по умолчанию.

В настоящее время автоматическое обновление не поддерживается ни для одного из экранов. Перезагрузите страницу вручную.

Панель мониторинга

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

Снимок экрана: журнал панели мониторинга.

Каждая строка на обеих панелях соответствует уникальному заданию. Задание может содержать один или несколько экземпляров runbook. В каждой строке отображается:

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

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

Модули runbook

При выборе модуля Runbook в дереве навигации или ссылке runbook приложение переходит на экран Runbook. На верхней панели перечислены метаданные модуля Runbook (состояние редактирования, метки времени и т. д.). Кнопка Выполнить позволяет ставить модуль Runbook в очередь для выполнения на требуемом подмножестве серверов Runbook. Кнопка Выполнить отключена для модулей Runbook, которые не отображаются в состоянии «Опубликовано «.

Снимок экрана: представление runbook.

Под этой панелью находится представление с вкладками:

Представление: для графического образа Runbook.
Задания: список активных и завершенных заданий модуля Runbook (см. ниже).
Экземпляры: список активных и завершенных экземпляров модуля Runbook во всех его заданиях (см. ниже).

Вы можете выбрать строки в представлении Задания так же, как на экране Панели мониторинга. Выполняемые задания можно остановить с помощью кнопок справа от выполняемой строки.

Снимок экрана: задания runbook.

Снимок экрана: экземпляры runbook.

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

Задания

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

После панели отображается таблица Экземпляры этого задания.

Снимок экрана: сведения о задании.

Большинство заданий имеют один экземпляр. Если модуль Runbook имеет действие триггера мониторинга или события, то каждый триггер запускает уникальный экземпляр задания. На следующем снимку экрана показано задание с несколькими экземплярами.

Снимок экрана: экземпляры заданий.

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

Состояние задания отображается визуально с помощью значков:

Значок	Состояние
Три точки	Задание поставлено в очередь
Песочные часы	Задание выполняется
Круг со косой чертой	Задание отменено
Tick	Задание успешно завершено
Красный восклицательный знак	Задание завершено, но не выполнено
Предупреждение	Задание завершено с предупреждениями

Экземпляры

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

Снимок экрана: экземпляр.

На верхней панели также есть три кнопки навигации:

Предыдущая статья. Просмотр экземпляра, который выполнялся до этого экземпляра.
Далее: Просмотр экземпляра, запущенного после этого экземпляра.
Последняя: просмотр последнего экземпляра.

Снимок экрана: сведения об экземпляре runbook.

Снимок экрана: сведения о runbook.

Идентификатор задания совпадает, и так как второй экземпляр по-прежнему выполняется, задание также выполняется.

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

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

Снимок экрана: подробные сведения об экземпляре.

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

Состояние экземпляра и действия совпадают по формату с состоянием задания.

Выполнение модулей Runbook

Перейдите на экран Runbook нужного модуля Runbook и выберите Выполнить. Справа откроется форма наложения, в которой вам будет предложено:

Задайте значения для всех входных параметров (обязательно).
Выберите набор серверов Runbook, на которых можно запланировать это задание.

Снимок экрана: параметризованный запуск.

Только один из этих серверов будет выполнять это задание. Чтобы выполнить модуль Runbook на нескольких серверах, необходимо выполнить эти задания и явно задать серверы по одному.

Введите параметры в форме, иначе форма не будет рассматриваться.

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

Снимок экрана: уведомление очереди заданий.

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

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

Снимок экрана: уведомление о остановке задания.

Часто задаваемые вопросы

Консоль не загружается; ошибка «Ой! Появится проблема с подключением к WebApi [состояние 0]».

Снимок экрана: консоль ошибок.

Проверьте консоль разработчика браузера (вкладка Консоль) и найдите ошибки CORS (заблокированные политикой CORS).
Если ошибки CORS отсутствуют, проверка журналы Просмотр событий (приложение) на компьютере веб-API.

Чтобы исправить ошибки CORS, необходимо убедиться, что файл API web.config должен иметь подходящую конфигурацию CORS. Ошибка браузера показывает значение источника, которое ожидается в веб-API web.config . Хотя доменные имена не учитывают регистр, IIS CORS использует тест сравнения с учетом регистра. Убедитесь, что origin значение в конфигурации IIS CORS указано в нижнем регистре.

Типичная конфигурация IIS CORS для веб-API:

Дополнительные сведения о настройке CORS в см. в web.config этой статье о конфигурации модуля CORS.

Разделы справки обновить URL-адрес веб-API?

Консоль загружает \assets\configuration.json , чтобы найти URL-адрес API. Этот файл можно изменить с помощью обычного текстового редактора. Убедитесь, что в конце URL-адреса нет конечной / черты (косая черта).

Область навигации

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

Рабочая область «Модули Runbook»

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

Итоги

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

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

Модули runbook

Вкладка Модули Runbook появляется при выборе папки в рабочей области Модули Runbook . На вкладке перечисляются модули Runbook, содержащиеся в выбранной папке, и показывается состояние всех выполняемых заданий и экземпляров каждого Runbook. Чтобы выбрать один из этих модулей Runbook и управлять их действиями, выберите параметр в области Действия . Если у вас много модулей Runbook, можно уточнить список, указав фильтр.

Задания

Вкладка Задания появляется при выборе папки или модуля Runbook в рабочей области Модули Runbook . На этой вкладке перечисляются задания, созданные для данного модуля Runbook, и состояние их завершения. Для папки показываются задания, созданные для всех модулей Runbook в папке, и состояние их завершения. Задание — это запрос к серверу Runbook на запуск Runbook. Оно создается каждый раз, когда Runbook получает запрос на запуск. Если Runbook запускается с монитором, он создает задание, которое постоянно выполняется до тех пор, пока Runbook не будет остановлен. В этом случае в состоянии задания отображается песочные часы, указывающие, что оно выполняется в данный момент.

Экземпляры

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

Рабочая область серверов Runbook

В рабочей области Серверы Runbook можно просматривать состояние текущих и выполненных заданий и экземпляров по каждому серверу Runbook.

Задания

На вкладке Задания перечисляются задания, которые были запущены на сервере Runbook, и состояние их завершения. Задание — это запрос к серверу Runbook на запуск Runbook. Оно создается каждый раз, когда Runbook получает запрос на запуск. Если Runbook запускается с монитором, он создает задание, которое постоянно выполняется до тех пор, пока Runbook не будет остановлен. В этом случае в состоянии задания отображается песочные часы, что означает, что оно выполняется в данный момент.

Экземпляры

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

Рабочая область «События»

В рабочей области События можно просматривать события журнала. По умолчанию события журнала включают все события для сервера Management и всех серверов Runbook. Чтобы ограничить события, выберите Фильтр и укажите условия для ограничения отображаемых событий. Если событие является специфичным для некоторого сервера Runbook, в поле Источник отображается название сервера. В этом случае можно выбрать событие, а затем выбрать Просмотр сервера Runbook в области Действия . Если выбрать Просмотреть сервер Runbook, откроется вкладка Задания в рабочей области Серверы Runbook для этого сервера Runbook.

Запуск консоли Orchestration в браузере

Откройте браузер.
В адресной строке введите http://computer name/:port number , где имя компьютера — это имя сервера, на котором установлена веб-служба, а порт — номер порта, выбранный во время настройки веб-службы. По умолчанию используется порт 82.

Запустите консоль Orchestration в Designer Runbook

Выберите консоль оркестрации на панели инструментов.

Примечание Если URL-адрес не задан для консоли Orchestration, вы получите сообщение об ошибке. Чтобы задать URL-адрес, выполните следующие действия.

Задайте URL-адрес консоли оркестрации в Designer Runbook

Выберите Параметрыи затем выберите Консоль Orchestration.
В поле URL-адрес введите http://computer name:port number , где имя компьютера — это имя сервера, на котором установлена веб-служба, а port — номер порта, выбранный во время настройки веб-службы. По умолчанию используется порт 82.
Нажмите кнопку Завершить.

Запуск и остановка модулей Runbook

Помимо просмотра состояния runbook, вы также можете запустить и остановить модуль Runbook в консоли Оркестрации. При запуске Runbook создается задание, которое ожидает появления доступного сервера Runbook для обработки Runbook. Если первое действие модуля Runbook — монитор, задание непрерывно выполняется, потенциально создавая несколько экземпляров Runbook, до тех пор пока Runbook или задание не будут остановлены. Если сервер Runbook доступен, задание предоставляет экземпляр Runbook для обработки серверу Runbook. Для выполняющегося Runbook имеется по крайней мере одно задание и один или несколько связанных с ним экземпляров.

При остановке Runbook, данный модуль Runbook, все задания и все экземпляры, связанные с Runbook, останавливаются.

Запуск runbook

Выберите Модули Runbook, чтобы открыть рабочую область Runbooks .
Если модуль Runbook находится в папке, выберите папку на панели Модули Runbook .
Откройте вкладку Модули Runbook на панели результатов.
Выберите модуль Runbook, а затем в области Действия выберите Запустить модуль Runbook.
Если для модуля Runbook требуются параметры, они отображаются в области Параметры runbook . Выберите столбец Значение для каждого модуля Runbook и введите значение для используемого модуля Runbook.
Если вы хотите запустить runbook на сервере, отличном от сервера по умолчанию, выберите сервер в области Доступные серверы Runbook , а затем щелкните стрелку вправо, чтобы добавить сервер в область Выбранные серверы Runbook .

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

Остановка модуля Runbook

Выберите Модули Runbook, чтобы открыть рабочую область Runbooks .
Если модуль Runbook находится в папке, выберите папку на панели Модули Runbook .
Откройте вкладку Модули Runbook на панели результатов.
Выберите модуль Runbook, а затем в области Действия выберите Остановить модуль Runbook.
Нажмите кнопку ОК в сообщении, чтобы подтвердить, что вы хотите остановить задания.
Если модуль Runbook был успешно запущен, вы получите подтверждение того, что задание остановлено. Если для данного Runbook нет выполняющихся заданий, вы получите сообщение о том, что никакие задания не выполнялись.

Просмотр состояния модуля Runbook в консоли оркестрации

Выберите Модули Runbook, чтобы открыть рабочую область Runbooks .
Если модуль Runbook находится в папке, выберите папку на панели Модули Runbook .
Откройте вкладку Модули Runbook на панели результатов.
Выберите Runbook.
Чтобы просмотреть все задания, созданные данным Runbook, на панели Действия выберите Просмотреть задания.
Чтобы просмотреть все экземпляры, созданные данным Runbook, на панели Действия выберите Просмотреть экземпляры.

Остановка заданий

Задание — это запрос на запуск Runbook. Задание создается только при наличии запроса на запуск Runbook. Если первое действие в Runbook — монитор, задание выполняется непрерывно до тех пор пока Runbook или задание не будут остановлены. Песочные часы обозначает состояние выполняющегося задания. Экземпляр — это выполняющаяся копия Runbook.

Вы не можете запустить задание; вы можете запустить только модуль Runbook.

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

Переход на веб-компоненты HTML5

Веб-компоненты HTML5 были выпущены в декабре 2021 г. в записи блога. В выпуске представлен REST API .NET Core 5 и переработанная консоль HTML5 (без Silverlight).

Рекомендуется перейти на веб-компоненты .NET Core 6 (версия 10.19.350.0), которые будут поддерживаться в рамках политики поддержки System Center 2019.

Ниже приведены улучшения, внесенные в веб-компоненты.

Обновление до последней версии LTSC .NET Core 6. Поддержка .NET 5 завершена .
Job start Параметры формы в веб-консоли .NET 5 были обязательными.
Горизонтальная прокрутка, добавленная в дерево навигации, устраняет отрисовку глубоко вложенного содержимого.
Защита конечных точек API была выполнена, и устранены проблемы, связанные с неуслеживаемые разрешениями пользователей.
Метки времени, видимые в консоли, теперь соответствуют часовой поясу системы.
Модули Runbook на корневом уровне (то есть без родительской папки) теперь видны.
Спецификация Swagger (также известная как OpenAPI), описывающая API, публикуется вместе с приложением.
Упаковано в установщик Майкрософт (.msi) вместе с пользовательским интерфейсом установщика для упрощения установки и удаления.

Условия для установки

Включенный Setup.exe тест будет проверять и запрашивать следующие отсутствующие предварительные требования:

Пакет размещения .NET 6
Модули IIS: CORS и переопределение URL-адресов.

Выпуск версии 10.19.350.0 можно установить параллельно с веб-компонентами .NET 5 и SilverLight.

Переход с веб-компонентов .NET 5 на .NET 6 (версия 10.19.350.0)
Переход с веб-компонентов SilverLight на .NET 6 (версия 10.19.350.0)

Выполните следующую команду PowerShell, чтобы извлечь пакет выпуска версии 10.19.350.0 из DLC и запустите Setup.exe :

Setup.exe /components:webapi,webconsole

Ознакомьтесь с документацией по API и установщику консоли и выполните действия, показанные в Setup.exe .

Установщик автоматически создаст новые сайты IIS со свежими web.config . Возможно, вы внесли изменения ( web.config например, добавили домены в разрешенные источники CORS, параметры базы данных и другие элементы сайта IIS). Сравните предыдущий и новый web.config и обновите новый web.config при необходимости.

Спецификация API (Swagger/OpenAPI) включена в формат JSON и может быть визуализирована с помощью средства предварительного просмотра swagger на ваш выбор, например редактора Swagger.

Чтобы устранить распространенные проблемы, ознакомьтесь с разделом Часто задаваемые вопросы. Освоив выпуск версии 10.19.350.0, вы можете удалить приложения .NET 5 и соответствующие сайты IIS.

Так как это новая установка, может потребоваться просмотреть сайт IIS и web.config созданный установщиком. Было бы полезно добавить домены консоли в список разрешенных источников CORS API.

Выполните следующую команду PowerShell, чтобы извлечь пакет выпуска версии 10.19.350.0 из DLC и запустите Setup.exe :

Setup.exe /components:webapi,webconsole

Ознакомьтесь с документацией по API и установщику консоли и выполните действия, показанные в Setup.exe .

Спецификация API (Swagger/OpenAPI) включена в формат JSON и может быть визуализирована с помощью средства предварительного просмотра swagger на ваш выбор, например редактора Swagger.

Вопросы и ответы

После перехода к консоли HTML5 с помощью браузера я вижу Uh Oh! Проблемы с подключением к сообщению API .

Проверьте журналы консоли браузера (нажмите клавиши SHIFT+CTRL+I в Microsoft Edge) и проверьте, есть ли ошибка CORS. Ошибка CORS означает, что URL-адрес веб-консоли не был добавлен в список разрешенных источников API.

Если запросы завершилися ошибкой с кодом 401, это означает, что произошел сбой проверки подлинности.

Убедитесь, что удостоверение, с которым работает браузер, имеет права на чтение ресурсов Orchestrator. Эти разрешения можно предоставить с помощью Designer Runbook. Вы можете изменить удостоверение процесса браузера, открыв браузер с помощью параметра Запуск от имени.
Убедитесь, что проверка подлинности Windows включена в функциях IIS и что метод включен на сайте IIS.

Я наблюдаю около 500 ответов об ошибках

Для отправки запросов к API можно использовать любой клиент REST. Если API не удается подключиться к базе данных или необходимая среда выполнения .NET не установлена, возникают ошибки с кодом 500. Сведения об ошибке отображаются в журналах событий ETW (используйте Просмотр событий), которые могут выявить первопричину.

Проверьте, работает ли API, выполнив следующую команду PowerShell:

Для PowerShell версии 5.1

Invoke-RestMethod http://localhost:/api/login -UseDefaultcredentials

Для Версии PowerShell 7.x

Invoke-RestMethod http://localhost:/api/login -UseDefaultcredentials -AllowUnencryptedAuthentication

Установщик не создавал конечные точки HTTPS (TLS), они мне нужны.

Настройка TLS выходит за рамки область наших установщиков. Вам потребуется следовать документации по IIS. После настройки убедитесь, что домен https веб-консоли также добавлен в список разрешенных источников CORS.

Консоль Orchestrator — это одностраничное приложение, которое помогает отслеживать и выполнять развертывание Orchestrator. В этой статье подробно описаны поддерживаемые функции консоли Orchestrator 2022.

Снимок экрана: панель мониторинга.

Область навигации

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

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

Панель мониторинга

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

Снимок экрана: журнал панели мониторинга.

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

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

Модули runbook

При выборе модуля Runbook в дереве навигации или ссылке runbook приложение переходит на экран Runbook. На верхней панели перечислены метаданные модуля Runbook (состояние редактирования, метки времени и т. д.). Кнопка Выполнить , доступная на экране, позволяет ставить runbook в очередь для выполнения на нужном подмножестве серверов Runbook. Кнопка Выполнить отключена для модулей Runbook, которые не отображаются в состоянии «Опубликовано «.

Снимок экрана: представление runbook.

Под этой панелью находится представление с вкладками:

Представление: для графического образа Runbook.
Задания: список активных и завершенных заданий модуля Runbook (см. ниже).
Экземпляры: список активных и завершенных экземпляров модуля Runbook во всех его заданиях (см. ниже).

Снимок экрана: задания runbook.

Снимок экрана: экземпляры runbook.

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

Задания

После панели отображается таблица Экземпляры этого задания.

Снимок экрана: сведения о задании.

Большинство заданий имеют один экземпляр. Если модуль Runbook имеет действие триггера мониторинга или события, то каждый триггер запускает уникальный экземпляр задания. На приведенном ниже снимку экрана показано задание с несколькими экземплярами.

Снимок экрана: экземпляры заданий.

Состояние задания отображается визуально с помощью значков:

Три точки: задание поставлено в очередь
Песочные часы: задание выполняется
Круг со косой чертой: задание отменено
Такт: задание успешно завершено
Красный восклицательный знак: задание завершено, но не выполнено
Предупреждение. Задание завершено с предупреждениями

Экземпляры

Снимок экрана: экземпляр.

На верхней панели также есть три кнопки навигации:

Предыдущая статья. Просмотр экземпляра, запущенного до этого экземпляра.
Далее: просмотр экземпляра, запущенного после этого экземпляра.
Последняя: просмотр последнего экземпляра

Снимок экрана: сведения об экземпляре runbook.

Снимок экрана: сведения о runbook.

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

Снимок экрана: подробные сведения об экземпляре.

Состояние экземпляра и действия совпадают по формату с состоянием задания.

Выполнение модулей Runbook

Установка значений для всех входных параметров (обязательно)
Выберите набор серверов Runbook, на которых можно запланировать это задание.

Снимок экрана: параметризованный запуск.

Только один из этих серверов фактически выполнит это задание. Чтобы выполнить модуль Runbook на нескольких серверах, необходимо запустить это количество заданий и явно задать серверы по одному.

Введите параметры в форме, иначе форма не будет рассматриваться.

Снимок экрана: уведомление очереди заданий.

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

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

Снимок экрана: уведомление о остановке задания.

Часто задаваемые вопросы

Консоль не загружается; ошибка «Ой! Отображается проблема с подключением к WebApi [состояние 0]»

Снимок экрана: консоль ошибок.

Проверьте консоль разработчика браузера (вкладка Консоль) и найдите ошибки CORS (заблокированные политикой CORS).
Если ошибки CORS отсутствуют, проверка журналы Просмотр событий (приложение) на компьютере веб-API.

Типичная конфигурация IIS CORS для веб-API:

Дополнительные сведения о настройке CORS в см. в web.config этой статье о конфигурации модуля CORS.

Разделы справки обновить URL-адрес веб-API?

Консоль Orchestration — это одна веб-страница, которая состоит из нескольких областей и рабочих областей. В этой статье описаны эти панели и рабочие области, а также приведены процедуры для доступа к консоли и управления модулями Runbook.

Область навигации

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

Рабочая область «Модули Runbook»

Итоги

Модули runbook

Вкладка Модули Runbook появляется при выборе папки в рабочей области Модули Runbook . На вкладке перечисляются модули Runbook, содержащиеся в выбранной папке, и показывается состояние всех выполняемых заданий и экземпляров каждого Runbook. Чтобы выбрать один из этих модулей Runbook и управлять их действиями, выберите параметр в области Действия . Если имеется большое количество модулей Runbook, можно сократить список, настроив фильтр.

Задания

Экземпляры

Рабочая область серверов Runbook

Задания

Экземпляры

Рабочая область «События»

Запуск консоли Orchestration в браузере

Откройте браузер.
В адресной строке введите http://computer name/:port number , где имя компьютера — это имя сервера, на котором установлена веб-служба, а порт — номер порта, выбранный во время настройки веб-службы. По умолчанию используется порт 82.

Запустите консоль Orchestration в Designer Runbook

Нажмите кнопку Консоль оркестрации на панели инструментов.

Если URL-адрес не задан для консоли Orchestration, вы получите сообщение об ошибке. Чтобы задать URL-адрес, выполните следующие действия.

Задайте URL-адрес консоли Orchestration в Designer Runbook

Выберите Параметрыи затем выберите Консоль Orchestration.
В поле URL-адрес введите http://computer name:port number , где имя компьютера — это имя сервера, на котором установлена веб-служба, а порт — номер порта, выбранный во время настройки веб-службы. По умолчанию используется порт 82.
Нажмите кнопку Завершить.

Запуск и остановка модулей Runbook

Кроме просмотра текущего состояния Runbook, можно также запускать и останавливать Runbook из консоли Orchestration. При запуске Runbook создается задание, которое ожидает появления доступного сервера Runbook для обработки Runbook. Если первое действие модуля Runbook — монитор, задание непрерывно выполняется, потенциально создавая несколько экземпляров Runbook, до тех пор пока Runbook или задание не будут остановлены. Если сервер Runbook доступен, задание предоставляет экземпляр Runbook для обработки серверу Runbook. Для выполняющегося Runbook имеется по крайней мере одно задание и один или несколько связанных с ним экземпляров.

При остановке модуля Runbook он, все задания и все экземпляры, связанные с модуном runbook, останавливаются.

Выберите необходимую вкладку для действий по запуску, остановке или просмотру состояния модуля Runbook:

Запуск модуля Runbook
Остановка модуля Runbook
Просмотр состояния модуля Runbook

Чтобы запустить модуль Runbook, выполните следующие действия.

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

Примечание При добавлении нескольких серверов в область Выбранные серверы Runbook модуль Runbook запускается только на первом сервере, если он доступен. Другие серверы являются серверами резервного копирования, на которых runbook работает только в том случае, если сервер-источник недоступен.

Чтобы остановить модуль Runbook, выполните следующие действия.

Выберите Модули Runbook, чтобы открыть рабочую область Модули Runbook .
Если Runbook хранится в папке, выберите соответствующую папку на панели Модули Runbook .
Откройте вкладку Модули Runbook на панели результатов.
Выберите модуль Runbook, а затем в области Действия выберите Остановить runbook.
Нажмите кнопку ОК в сообщении, чтобы подтвердить, что вы хотите остановить задания.
Если модуль Runbook был успешно запущен, вы получите подтверждение того, что задание остановлено. Если для данного Runbook нет выполняющихся заданий, вы получите сообщение о том, что никакие задания не выполнялись.

Выполните следующие действия, чтобы просмотреть состояние модуля Runbook в консоли Orchestration:

Выберите Модули Runbook, чтобы открыть рабочую область Модули Runbook .
Если Runbook хранится в папке, выберите соответствующую папку на панели Модули Runbook .
Откройте вкладку Модули Runbook на панели результатов.
Выберите Runbook.
Чтобы просмотреть все задания, созданные модуном runbook, в области Действия выберите Просмотреть задания.
Чтобы просмотреть все экземпляры, созданные модуном runbook, в области Действия выберите Просмотреть экземпляры.

Остановка заданий

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

Вы не можете запустить задание; вы можете запустить только модуль Runbook.

Дальнейшие действия

Дополнительные сведения о развертывании модулей Runbook см. в статье Развертывание модулей Runbook.

UpdateOrchestrator API

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

Windows 20H1 включает решение первого поколения для вариантов использования автоматического обновления программного обеспечения, которые были приняты обновлениями ОС и обновлениями приложений Магазина, и предоставляет начальную версию этого API с ограниченным доступом для выбранного набора средств обновления приложений в пользовательском режиме, как описано ниже.

Компоненты

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

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

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

Аудитория разработчиков

API UpdateOrchestrator в настоящее время является функцией ограниченного доступа. Этот API станет общедоступным в будущем выпуске.

Используйте API UpdateOrchestrator, если у вас уже есть фоновые средства обновления программного обеспечения для приложений Win32 в «пользовательском режиме», таких как средство обновления Adobe для Acrobat Reader или Steam в Valve. Этот интерфейс не требуется для приложений UWP/Store, так как Microsoft Store уже использует преимущества этой функции для обновлений программного обеспечения.

Чтобы обеспечить оптимальное взаимодействие с клиентами, этот первоначальный выпуск API ограничен набором зарегистрированных средств обновления, которые соответствуют следующим критериям:

Обновления только для приложений в режиме пользователя

Не включайте драйверы BIOS, встроенного ПО, устройства или программного обеспечения

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

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

Наша цель — улучшить функциональность этого API и уменьшить влияние нескольких автоматических средств обновления программного обеспечения в Windows. Мы будем признательны за ваш вклад в этот краткий опрос , чтобы помочь нам понять, как API UpdateOrchestrator может лучше удовлетворить потребности разработчика.

Обратная связь

Были ли сведения на этой странице полезными?