Мониторинг Web-сервисов

Функционал данного инструмента позволяет:

• Быстро настраивать подключение к неограниченному количеству Web-Сервисов;
• Кешировать описания WSDL и проверять наличие изменений;
• Проводить быстрый анализ изменений описаниях WSDL (Источник: WS-Ссылка, WS-Прокси или Кэш);
• Выгружать пакеты Фабрик XDTO в формате XSD;
• Сохранять настройки подключения в формате XML;
• Запускать в обычном приложении, и в управляемых формах;
• Выполнять программный запуск и использовать в фоне;
• Оповещать о изменениях по электронной почте;
• Использовать встроенную систему логирования;
• Запускать в любой конфигурации, использующей платформу 8.х;
• Не требует добавления в конфигурацию WS-Ссылок;

Обработку можно запускать из файла или регламентным заданием.

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

Для использования обработки необходимо настроить учетную запись электронной почты, получателей, и настройки подключения к Web-Сервисам.

После настройки обработки необходимо проверить подключение и кешировать WSDL для каждого Web-Сервиса.  Далее проверка подключения проводит сравнение кэшированной схемы WSDL с текущей. Изменения WSDL можно отобразить визуально на закладке «Сравнение WSDL».

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

Архив с данными для первого запуска и подробную инструкцию можно найти в обработке.

Тестирование проводилось на платформе 8.3.20.1674.

Инструкция по работе с обработкой «Мониторинг доступности и изменения описания Web-сервисов».

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

Описание команд Мониторинг доступности и изменения описания Web-сервисов:

Страницы «Настройки» => «Настройки Подключения»

1. Команда «Добавить» - Добавляет строку данных авторизации для подключения к Web-Сервису.
2. Команда «Восстановить настройки» -  Восстанавливает «Настройки обработки» из регистра сведений «XXX_НастройкиОбменовСВебСервисами»..
3. Команда «Сохранить настройки» - Сохраняет  ««Настройки обработки» в регистр сведений «XXX_НастройкиОбменовСВебСервисами».
4. Группа команд «Внешние настройки» - см. ниже.
5. Команда «Проверить подключение сервиса» - Проверяем подключение к отмеченным web-сервисам, и определяем его статус.

1. Сохраняет «Настройки Подключения», «Настройки обработки» в файл.
2. Восстанавливает «Настройки Подключения», «Настройки обработки» в файл.

Страницы «Настройки» => «Настройки»

1. Отметка «Тестировать подключение к Proxy» - Включает проверку соединения с Web-Сервисами.
2. Отметка «Проверять на различия XSD из WS-Cсылки или WS-Прокси» - Включает проверку идентичности схемы обмена выгруженной из сервиса и последней кэшированной схемы.
3. Отметка «Использовать для отладки WS-Ссылки (Вкл)  или Прокси (Выкл)» - Переключаем источник WS-Определений (WS-Ссылки/WS-Прокси).
4. Отметка «Сообщать об ошибках» - Включает оповещение о ошибках (Информация о ошибках фиксируется в логе в любом случае).
5. Отметка «Записывать лог в журнал регистрации» - Включает запись лога выполнения мониторинга в журнал регистрации.

7.   Команда «Открыть справку обработки» -  Открывает инструкцию в формате Word.

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

Страницы «Настройки» => «Настройки» => «Настройки рассылки»

9. Отметка «Уведомлять по электронной почте» - Включает уведомление по Электронной почте.
10. Отметка «Вкладывать лог» - Включает вложение лога в формате txt в письмо.
11. Команда «Добавить» - Добавляет Адреса Email для уведомления в таблицу.
12. Таблица «Адресов Email для уведомления» - Позволяет управлять адресатами почтовой рассылки.

Страницы «Настройки» => «Настройки» => «Учетная запись электронной почты»

1. Поле «Адрес электронной почты» - Адрес электронной почты.
2. Поле «Логин SMTP» - Логин.
3. Поле «Пароль SMTP» - Пароль.
4. Поле «SMTPСервер» - Сервер.
5. Поле «Порт SMTP» - Порт.
6. Поле «Время ожидания сервера» - Время ожидания сервера.
7. Гиперссылка «Версия» - Версия обработки «Мониторинг доступности и изменения описания Web-сервисов».

Страницы «Настройки» => «Работа с файлами»

1. Поле выбора «Файл для восстановления настроек» - Путь к файлу для восстановления настроек.
2. Поле выбора «Папка для сохранения настроек» - Путь к файлу для сохранения настроек.

Страница «Сравнение WSDL»

1. Поле «Сервис» - Выбираем сервис для сравненния.
2. Команда «WSDL из Proxy в ДЗ» - Преобразовать WSDL из Proxy в дерево значений.
3. Команда «Кэшировать WSDL» - Записывает текущую WSDL в регистр сведений «XXX_НастройкиОбменовСВебСервисами». В последствии механизм сравнения проверки изменений будет сравнивать пакеты полученные из прокси именно с этим кэшем.
4. Команда «WSDL из Кэша в ДЗ» - Преобразовать WSDL из кэша в дерево значений.
5. Команда «WSDL из WS-Ссылки в ДЗ» - Преобразовать WSDL из WS-Ссылки в дерево значений.
6. Команда «Сравнить деревья» - Сравнивает содержимое правого и левого дерева и подкрашивает изменения.
7. Команда «Следующее изменение» - Переход текущей строки на следующее изменение в правом и левом дереве.

Страниц  «Логирование»

1. Поле «Лог» - Лог выполнения мониторинга.

Функционал обработки «Мониторинг доступности и изменения описания Web-сервисов».

Запуск обработки «Мониторинг доступности и изменения описания Web-сервисов»:

1. Запустить обработку «Мониторинг доступности и изменения описания Web-сервисов».
2. В форме настроек обработки «Мониторинг доступности и изменения описания Web-сервисов», перейти на страницы «Настройки» => «Настройки тестирования».
3. С помощью команды  «Сохранить данные для первого запуска» - Сохранить в локальную папку архив, содержащий в себе конфигурацию для объединения. Так же в архиве можно найти шаблоны настроек для пробного запуска.
4. Объединить конфигурации. Для корректной работы обработки «Мониторинг доступности и изменения описания Web-сервисов», необходимо в конфигурации БД забрать регистры сведений и «XXX_НастройкиОбменовСВебСервисами».
5. Произвести настройку обработки.

Настройка подключения Мониторинг доступности и изменения описания Web-сервисов:

1. В форме настроек обработки «Мониторинг доступности и изменения описания Web-сервисов», перейти на страницы «Настройки» => «Настройки подключения».
2. В табличную часть добавить строки с настройками подключения.

Настройки подключения имеют следующую структуру:

1. Колонка «Отметка» - Позволяет включить или отключить подключение в текущему веб сервису.
2. Колонка «Статус подключения» - В данном поле отображается статус подключения и его проверки. Редактирование запрещено.
3. Колонка «Пользовательское имя сервиса» - Так как наименования сервисов продуктивного и тестового контура могут быть идентичны, введено данное изменение. «Пользовательское имя сервиса» может быть заполнено только по правилам заполнения наименований объектов конфигурации и не может повторяться. По значению «Пользовательского имя сервиса» может быть инициализирована WS-Ссылка. Если она добавлена в конфигурацию, и если её наименование в конфигурации и пользовательское имя сервиса идентичны.
4. Колонка «URL Веб сервиса» - Адрес Web-Сервиса в интернете.      
5. Колонка «Адрес WSDL» -  Адрес WSDL Web-Сервиса в интернете. Как правило, совпадает с URL Веб сервиса.

6. Колонка «Имя пользователя» - Логин.
7. Колонка «Пароль» - Пароль.
8. Колонка «Имя сервиса» - Значение wsdl:service name.

9. Колонка «URI Пространства имен» - Значение targetNamespace.

10. Колонка «Имя точки подключения» - Значение wsdl:service => wsdl:service => name.

11. Колонка «Защищенное соединение» - Не заполняется.
12. Колонка «Таймаут» - Стандарт 10 – 15с.
13. Колонка «WS Прокси» - Не заполняется.

Командой «Проверить подключение сервиса» - Проверяем подключение  отмеченных  web-сервисов, и определяем его статус.

Статусы могут принимать следующие значения:

1. Подключение не установлено – Статут оповещает о том, что подключение к сервису НЕ установлено.
2. Подключение установлено (WSDL различны) – Статут оповещает о том, что подключение к сервису установлено.  Проверка на различия XSD из WS-Cсылки или WS-Прокси пройдена успешно.                           
3. Подключение установлено (WSDL идентичны) - Статут оповещает о том, что подключение к сервису установлено.  Но проверка на различия XSD из WS-Cсылки или WS-Прокси не пройдена.                                  
4. Подключение установлено - Статут оповещает о том, что подключение к сервису установлено, но проверка на различия XSD из WS-Cсылки или WS-Прокси отключена.
5. Использование сервиса отключено - Статут оповещает о том, что использование сервиса отключено.
6. Тестирование подключения отключено - Статут оповещает о том, что Тестирование  сервиса отключено.

Важно!!!! При восстановлении ЛЮБЫХ настроек из регистра сведений всегда будет восстановлена последняя запись. Так как используется срез последних.

При первом успешном подключении к сервису статус подключения примет значение "Подключение к proxy установлено (Бинарные файлы различны)".

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

Сравнение WSDL

Для сравнения WSDL необходимо выбрать Сервис.

1. В правом окне нажать кнопку «WSDL из Proxy в ДЗ» - Будет заполнено левое дерево.
2. В правом окне нажать кнопку  «WSDL из Кэша в ДЗ» или «WSDL из WS-Ссылки в ДЗ» - будет заполнено правое дерево.
3. После нажать «Сравнить деревья» - После сравнения будет либо отображено сообщение «Деревья идентичны» либо будут окрашены различия.
4. Команда «Следующее изменение» - Команда будет доступна, если деревья различны.
5. Команда «Кэшировать WSDL» - Записывает текущую WSDL в регистр сведений «XXX_НастройкиОбменовСВебСервисами». В последствии механизм сравнения проверки изменений будет сравнивать пакеты полученные из прокси именно с этим кэшем.
6. Кэшировать WSDL необходимо после добавления нового подключения к Web-Сервису или После изменения Структуры WSDL.

Пример  «Оповещения о изменении статусов Web-Сервисов по электронной почте»: