Система управления интеграциями на базе 1С:Шины

• Разворачиваем 1С:Шину на Ubuntu и Windows [Шпаргалка]
• Переход с 1С:Шины 2.1.1 на 3.1.1 по Ubuntu [Квест]
• 1С:Шина. Пример синхронизации справочника
• Об 1С:Шине
• Как я из 1С:Шины к MySQL подключался
• Поинтегрируем: нужна ли Шина вам?
• Три инструмента для сервисов интеграции
• Поинтегрируем: сервисы интеграции – новый стандарт или просто коннектор?

• Сервисы интеграции без Шины и интеграции

 Файлы поставки:

• ОбменДаннымиПоШине1СБСП.cfe - расширение системы СУИ для конфигураций 1С, содержащих подсистему "Обмен данными" из состава БСП
• ОбменДаннымиПоШине1С.cfe - расширение системы СУИ для конфигураций 1С, не использующих такую подсистему
• ОбменДаннымиПоШине1С.cf - подсистема СУИ для конфигураций на обычных формах.
• BusDataExchange[номер сборки].xasm - проект приложения 1С:Шины.
• Описание формата сообщения интеграции.docx - дополнительная информация о формате сообщений, используемом в СУИ, и о методике добавления новых видов коннекторов в решение.

Шаг 1. Установить сервер шины. Инструкцию по установке и настройке можно найти на ИТС здесь.

Шаг 2. Открыть консоль шины через браузер, перейти на вкладку "Приложения", затем нажать "Новое приложение".


Шаг 3.  В окне создания нового приложения выбрать вкладку "Из проекта", установить отметку "Загрузить проект", нажать "Перетащите файл в окно или добавьте вручную", далее в диалоговом окне выбрать файл "BusDataExchange.xasm", нажать "Открыть".


Шаг 4. В окне создания нового приложения заполнить поле "Имя приложения", "Http путь приложения", выбрать "Тип СУБД". При необходимости установить отметку "Режим разработки". Нажать "Создать"


После удачной загрузки приложение отобразится в списке со статусом "Работает":


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

Шаг 5. Открыть конфигуратор базы 1С. Перейти "Конфигурация" - >  "Расширения конфигурации".


Шаг 6. Добавить расширение, выбрать в поле "Назначение" значение "Дополнение". Нажать "ОК"


Шаг 7. Активировать строку с расширением, выбрать из контекстного меню или из шапки формы "Конфигурация" ->  "Загрузить конфигурацию из файла"


Шаг 8. В диалоговом окне выбрать файл "ОбменДаннымиПоШине1СБСП.cfe" или "ОбменДаннымиПоШине1С.cfe" (в зависимости от наличия в конфигурации подсистемы "Обмен данными" из состава БСП БСП) и нажать "Открыть". После согласиться со всеми сплывающими окнами и обновить базу.

Шаг 12. В открывшейся форме заполнить следующие поля:

• "Ключ системы" - генерируется автоматически, используется при подключении информационной системы в Шине (смотрите Шаг 4);
• "Используется обмен данными по шине" - флаг, включающий в базе обмен данными по Шине;
• "Код текущей информационной системы" - должен совпадать с кодом информационной системы в Шине (смотрите Шаг 3);
• "Адрес внешнего сервиса интеграции" - скопировать URL приложения Шины (смотрите Шаг 10);
• "Имя пользователя (выдается сервисом)" - ключ API (идентификатор ключа) информационной системы в Шине (смотрите Шаг 9);
• "Пароль пользователя (выдается сервисом)" - ключ API (секрет ключа) информационной системы в Шине (смотрите Шаг 9).

Нажать кнопку "Подключить систему к Шине".

Шаг 13. После успешного подключения первой базы 1С к Шине она станет мастер-системой. Только в мастер-системе можно изменять настройки обмена данными по Шине, которые автоматически отражаются во все остальные базы, подключенные к ней. При необходимости мастер-систему можно изменить.


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


Отключить от шины можно только базу, которая не является мастер-системой. Если по каким-то причинам все-таки необходимо отключить мастер-систему, то это можно сделать, сбросив значение константы "Используется обмен данными по шине".

Шаг 14. После добавления базы можно настроить основные параметры системы для нее (Меню Обмен данными по шине 1С -> Сервис -> Основные настройки)


Все пояснения приведены прямо на форме настроек.

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

Шаг 1. Открыть базу 1С.  Перейти в подсистему "Обмен данными по шине 1С", затем в подразделе "Сервис" выбрать "Изменение мастер-системы".


Шаг 2. В открывшемся окне нажать кнопку "Изменить мастер-систему на текущую".


Шаг 3. В случае успешного изменения мастер-системы вы увидите следующее:

Элемент обмена для СУИ - основная единица, описывающая обмен данными.
В идеале это отражение обмена отдельной сущностью данных - элемент справочника "Физические лица", документ "Реализация товаров и услуг" и т.п.
На практике это может быть обмен целым набором сущностей. Особенно, если это обмен по КД2, например. Один документ, выгружаемый по определенному правилу, потянет за собой элементы справочников, другие документы и т.д.

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

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

Если настройки интеграции проводится до подключения каких-то баз к СУИ, то можно добавить их в справочник "вручную".

Для этого нужно открыть базу 1С, являющуюся мастер-системой. Перейти в подсистему "Обмен данными по шине 1С", выбрать "Информационные системы".


Шаг 2. В списке справочника нажать  кнопку "Создать". Затем в открывшейся форме справочника заполнить поля "Код" и "Наименование" и установить отметку "Использование".


Пример, списка информационных систем в базе 1С


Шаг 3. Перейти в подсистему "Обмен данными по шине 1С", затем выбрать "Элементы обмена данными".


Шаг 4.  В списке справочника нажать  кнопку "Создать". Затем в открывшейся форме справочника заполнить поле "Наименование" -  к примеру "ЗУП - Справочник - Должности".

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

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

• "Источник" - источник интеграции (более подробное описание настройки источника читайте ниже в подразделе "Настройка источника данных");
• "Получатель"  - получатель интеграции (более подробное описание настройки получателя читайте ниже в подразделе "Настройка получателя данных");
• "Модификатор преобразования в шине" - необязательный строковый модификатор, определяющий алгоритм обработки сообщения в программном коде приложения Шины.
  "Из коробки" доступен единственный модификатор "XDTO2JSON", нормализующий формат, который отдает платформа 1С.
  При необходимости можно реализовать в проекте приложения Шины необходимые вам алгоритмы обработки.

Далее установить отметку "Использование" в табличной части и в шапке элемента обмена. И нажать "Записать" или "Записать и закрыть".

Пример списка элементов обмена в базе 1С

 Шаг 1. Перейти в подсистему "Обмен данными по шине 1С", выбрать "Источники элементов обмена".


Шаг 2. В списке справочника нажать  кнопку "Создать". Затем в открывшейся форме справочника заполнить поля описания данных источника:

• "Информационная система" - выбрать/создать информационную систему источник;
• "Раздел метаданных" - раздел метаданных базы источника;
• "Имя метаданных"- имя метаданных базы источника.

Шаг 3. При необходимости можно установить флаг "Использовать отбор данных при регистрации". Тогда откроется форма отбора, где можно установить произвольное условие, при выполнение которого, должна будет выполняться регистрация данных к обмену.


Шаг 4. Поле "Вариант регистрации изменения" по умолчанию заполняется значением "Стандартный" (альтернативные варианты должны появиться позднее, по мере развития СУИ). Заполнить поле "Способ регистрации изменений" , из предложенного списка выбрать "Справочник" или "Регистр сведений" (рекомендуется).


Шаг 5. При необходимости можно установить флаг "Отложенная отправка данных", тогда станет видимо поле "Реквизит метаданных", где необходимо выбрать реквизит из объекта метаданных с типом дата. Это актуально, когда необходимо выгружать данные только в определенный момент времени. К примеру, запись о кадровой истории уже появилась в регистре, но сотрудник вступит на должность только с даты, которая указана в реквизите "Период", тогда в поле "Реквизит метаданных" указываем этот реквизит.


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


Шаг 7. Создать/выбрать "Способ обмена" - настройки формата выгружаемых данных (более подробное описание про способы обмена читайте ниже в подразделе "Настройка форматов данных сообщения"). После, если выбран способ обмена с видом обмена по КД2, необходимо выбрать значение для поля "Код (имя) правила выгрузки данных" (имя правила выгрузки данных для объекта).


Шаг 8. Заполнить или автоматический сгенерировать поле "Наименование", установить флаг "Использование". На этом настройка завершена, нажать "Записать" или "Записать и закрыть".

 Шаг 1. Перейти в подсистему "Обмен данными по шине 1С", выбрать "Способы обмена данными".


Шаг 2. В форме списка нажать кнопку "Создать". В первую очередь необходимо выбрать значение для поля "Вид обмена". Более подробное описание смотрите в разделе публикации "Форматы обмена данными".


Шаг 3. В зависимости от выбранного значения реквизита "Вид обмена", изменится отображение реквизитов формы справочника, которые необходимо заполнить. Далее по каждому виду отдельно:

• JSON

  Заполнить поле "Наименование" и при необходимости "Описание".
  

• XML

  Заполнить поле "Наименование" и при необходимости "Описание".
  

• 1С:Конвертация данных 2

  Скопировать текст файла правил обмена, сформированного с помощью КД2, и вставить в поле "Правила обмена КД2". Система предложит обновить правила выгрузки данных, рекомендуется согласиться, но можно и ввести их вручную.
  
  
  Заполнить поле "Наименование" и при необходимости "Описание".
  

• 1С:Конвертация данных 2 (БСП + план обмена)
  Выбрать из списка значение для поля "План обмена источник". План обмена используется в служебных целях, чтобы связать функционал СУИ с обработкой КонвертацияОбъектовИнформационныхБаз, входящей в состав подсистемы "Обмен данными" БСП. Требуется в составе плана обмена иметь настраиваемый объект для выгрузки. Других дополнительных настроек вносить не надо. Рекомендуется сделать один универсальный план обмена в конфигураторе, включить в состав все объекты конфигурации и запретить авторегистрацию для всех объектов.

  Скопировать текст фала правил обмена, сформированного с помощью КД2, и вставить в поле "Правила обмена КД2". Система предложит обновить правила выгрузки данных. Рекомендуется согласиться, но можно и ввести их вручную.
  
  
  После заполнения правил выгрузки данных зеленым цветом подсветятся строки с объектами метаданных, которые входят в состав плана обмена, заполненный в поле "План обмена источник". Заполнить поле "Наименование" и при необходимости "Описание".
  

• 1С:Конвертация данных 3 (Enterprise Data)
  Перейти в подсистему "Обмен данными по шине 1С", выбрать "Версии формата EnterpriseData".
  
  
  В форме списка справочника нажать кнопку "Создать". В форме элемента справочника "Версии формата EnterpriseData" заполнить поле "Пространство имен" и "Наименование".
  
  
  Аналогично для расширения формата, если имеется.
  
  
  Выбрать/создать "Версия формата EnterpriseData" и "Версия формата EnterpriseData (расширение формата)". Заполнить поле "Имя модуля менеджера обмена через универсальный формат" - модуль в котором содержатся правила обмена КД3.
  
  
  Заполнить поля "Наименование" и, при необходимости, "Описание".
  

• Произвольный

  Заполнить поля "Наименование" и, при необходимости, "Описание".
  

Шаг 1. Перейти в подсистему "Обмен данными по шине 1С", выбрать "Получатели элементов обмена".


Шаг 2.  В форме списка справочника нажать кнопку "Создать".  Заполнить поля "Наименование", "Код", "Информационная система".


Шаг 3. Установить флаг "Использование". После нажать "Записать" или "Записать и закрыть".


Шаг 4. Если требуется в базе получателе передать управление процедурой обработки получаемого сообщения в произвольный код, реализованный в переопределяемом модуле (в процедуре ПредварительнаяОбработкаПолученияСообщения), то необходимо установить флаг "Нестандартная обработка получения" и указать строковый "Модификатор обработки получения", который получит указанная процедура в качестве параметра.


Пример формы выбора получателей элементов обмена

Помимо взаимодействия с системами на платформе 1С, СУИ может "из коробки" взаимодействовать с брокером сообщений RabbitMQ.
Понятно, что на стороне системы, работающей через RMQ, необходимо поддержать формат сообщений, используемых СУИ (описание формата входит в поставку в отдельном файле "Описание формата сообщения интеграции.docx").
Вообще, при необходимости можно легко доработать СУИ для взаимодействия с любыми поддерживаемыми Шиной коннекторами. Для этого необходимо разместить в схеме интеграции блоки по аналогии с размещенными RMQ-блоками и дописать несколько строк кода (опять же, по аналогии) в паре мест программного модуля.

Здесь же пока опишу процесс подключения RMQ к СУИ.

Шаг 1.  Открыть консоль Шины, перейти во вкладку "Приложения" и в списке приложений выбрать URl приложения, к которому необходимо подключить базу 1С.


Шаг 2.  В открывшемся приложение перейти на вкладку "Инфосистемы" и нажать "Добавить систему".


 

Шаг 3. В форме добавления информационной системы заполнить поля и записать:

• "Код" - код информационной системы.

• "Наименование" - наименование информационной системы.

• "Exchange name rMQ" - задает, в какую точку обмена будет доставлено сообщение для дальнейшего распределения по очередям (в RabbitMQНазначение свойство "ИмяОбмена").

• "Host rMQ" - Имя или IP-адрес удаленного компьютера, с которым Шина устанавливает соединение (в RabbitMQНазначение свойство "Хост").

• "Password rMQ" - пароль пользователя для подключения к удаленному компьютеру (в RabbitMQНазначение свойство "Пароль").

• "Port rMQ" - порт, по которому устанавливается соединение с удаленным компьютером (в RabbitMQНазначение свойство "Порт").

• "Routing key rMQ" - ключ маршрутизации для RabbitMq. Этот ключ определит, куда будет направлено сообщение после попадания в exchange из RabbitMqИсточника (в RabbitMQНазначение свойство "КлючМаршрутизации").

• "System key" - произвольный ключ информационной системы. Обязательно к заполнению. Произвольная уникальная в рамках ключей систем строка.

• User name rMQ - имя пользователя для подключения к удаленному компьютеру (в RabbitMQНазначение свойство "ИмяПользователя").

• VHost rMQ - задает виртуальный хост. Виртуальный хост, в отличие от обычного хоста, понятие логическое. Он определяет права доступа пользователя к очередям и обменам RabbitMQ. Например, есть два виртуальных хоста vhost1, vhost2 и пользователь User. User может иметь доступ ко всем очередям на чтение, запись и добавление/удаление в vhost1, но в vhost2 он может только читать из очередей. Аналогично может быть два разных пользователя, привязанных к разным vhost (в RabbitMQНазначение свойство "ВиртуальныйХост").
  
   

Шаг 4. В приложение шины перейти на вкладку "Процессы" и выбрать необходимый процесс.


Шаг 5. На вкладке "Схема" выбрать "УчастникиОбменаRMQИсточник" и затем нажать "Состав группы".


Шаг 6. В форме состава группы отметить базу и нажать "Добавить в группу".


После информационная система переместится на вкладку "Действующие".

Шаг 1. Открыть консоль Шины, перейти во вкладку "Приложения" и в списке приложений выбрать URl приложения, к которому необходимо подключить базу 1С.


Шаг 2. В открывшемся приложение перейти на вкладку "Инфосистемы" и нажать "Добавить систему".


Шаг 3. В форме добавления информационной системы заполнить поля и записать:

• "Код" - код информационной системы.

• "Наименование" - наименование информационной системы.

• "QueueNameRMQ" - Имя очереди, из которой получаются сообщения (в RabbitMQНазначение свойство "ИмяКанала").

• Host rMQ - Имя или IP-адрес удаленного компьютера, с которым Шина устанавливает соединение (в RabbitMQНазначение свойство "Хост").

• Password rMQ - пароль пользователя для подключения к удаленному компьютеру (в RabbitMQНазначение свойство "Пароль").

• Port rMQ - порт, по которому устанавливается соединение с удаленным компьютером (в RabbitMQНазначение свойство "Порт").

• System key - произвольный ключ информационной системы. Обязательно к заполнению. Произвольная уникальная в рамках ключей систем строка.

• User name rMQ - имя пользователя для подключения к удаленному компьютеру (в RabbitMQНазначение свойство "ИмяПользователя").

• VHost rMQ - задает виртуальный хост. Виртуальный хост, в отличие от обычного хоста, понятие логическое. Он определяет права доступа пользователя к очередям и обменам RabbitMQ. Например, есть два виртуальных хоста vhost1, vhost2 и пользователь User. User может иметь доступ ко всем очередям на чтение, запись и добавление/удаление в vhost1, но в vhost2 он может только читать из очередей. Аналогично может быть два разных пользователя, привязанных к разным vhost (в RabbitMQНазначение свойство "ВиртуальныйХост").
  
   

Шаг 4. В приложение шины перейти на вкладку "Процессы" и выбрать необходимый процесс.

"Routing key rMQ" и "Exchange name rMQ" не могут быть одновременно пустыми, в таком случае сообщение не будет никуда доставлено. Если при отправке сообщения такое произойдет, Шина сгенерирует исключение, подсказывающее, как избежать данной проблемы: изменить свойство узла или задать ключ маршрутизации в параметрах сообщения.

Шаг 5. На вкладке "Схема" выбрать "УчастникиОбменаRMQПриемник" и затем нажать "Состав группы".


Шаг 6. В форме состава группы отметить базу и нажать "Добавить в группу".

После информационная система переместится на вкладку "Действующие".


Шаг 7. На этом подключение завершено, если планируется отправлять в RabbitMQ сообщения из базы 1С, то необходимо добавить созданную информационную систему в получатели и настроить обмен, как описано в предыдущих подразделах.

 В СУИ можно организовать регистрацию "по команде" и последующую передачу пакетов данных из одной информационной системы (на платформе 1С) в другую. Понятно, что в СУИ должным образом предварительно должны быть настроены элементы обмена.
"Команда" отдается запросом к http-сервису, опубликованному в Шине.
Формат запроса следующий:
http://[AdresEsb]/applications/[BusDataExchangeTest]/api/system/registerdataforexchange/[CodeFrom]/[CodeTo]/[ID]
где:

• AdresEsb - адрес сервера 1С:Шина.

• BusDataExchangeTest - имя приложения в Шине

• CodeFrom- код базы-источника (код в справочнике Инфосистем)

• CodeTo- код базы-приёмник

• ID- уникальный идентификатор запроса.

Тело запроса должно быть сформировано в формате JSON. Это может быть массив структур или одна структура. Один пакет  (структура) подразумевает набор запрашиваемых данных по одному объекту метаданных. Можно указать массив идентификаторов в атрибуте "ArrayIDorStructureSearch". Также можно передать структуру полей поиска в тот же атрибут. Пример тела запроса:

[
{   
    "PackageID": "1",
    "DataType": "Справочник",
    "DataKind": "Сотрудники", 
    "ArrayIDorStructureSearch": [
        {"ФизическоеЛицо": [
            {"Ссылка": "182dc500-6f56-11e1-a700-0007e9336836"}
            ]
        }
    ]
},
{   
    "PackageID": "2",
    "DataType": "Справочники",
    "DataKind": "Сотрудники", 
    "ArrayIDorStructureSearch": [
        {"ФизическоеЛицо": [
            {"Код": "00-0000063"}
            ]
        }
    ]
},
{   
    "PackageID": "3",
    "DataType": "Справочники",
    "DataKind": "Сотрудники", 
    "ArrayIDorStructureSearch": [
        {"Код":  "54321"},
        {"Наименование":  "Нурмухамедов Руслан Рушанович"}
            

    ]

},
{   
    "PackageID": "4",
    "DataType": "Справочники",
    "DataKind": "Должности", 
    "ArrayIDorStructureSearch": [
        "141d9bee-95db-11e6-83cb-005056ba7157",
        "e0670797-95d7-11e6-83cb-005056ba7157"
    ]
},
{
    "PackageID": "5",
    "DataType": "Справочники",
    "DataKind": "Сотрудники", 
    "ArrayIDorStructureSearch": [
        "21c16077-143b-11e0-acf6-0007e9336836",
        "f481766c-7f97-11e4-a1a4-005056ba7157"
    ]
}
]

При отправке запроса передаётся идентификатор, который и вернется в качестве ответа сервиса. Это сигнализирует лишь о том, что запрос был успешно доставлен и обработан в Шине. Далее сообщение отправляется в базу-источник 1С через сервис интеграции. В базе сообщение обрабатывается, при удачной обработке запрашиваемый набор данных регистрируется на обмен, при неудачной обработке делается запись с ошибкой в справочник "Входящие сообщения по шине 1С", входящий в состав расширения СУИ.