Механизм обмена данными

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

• относится к определенному плану обмена;
• имеет определенный узел-отправитель и определенный узел-получатель.

Важнейшей составляющей инфраструктуры сообщений являются сами сообщения. Сообщение оформляется как документ XML, имеющий определенную структуру. В качестве примера рассмотрим следующее сообщение:

<v8msg:Message xmlns:v8msg="http://v8.1c.ru/messages">
   <v8msg:Header>
      <v8msg:ExchangePlan>УдаленныеСклады</v8msg:ExchangePlan>
      <v8msg:To>Оптовый</v8msg:To>
      <v8msg:From>ЦентрОфис</v8msg:From>
      <v8msg:MessageNo>20</v8msg:MessageNo>
      <v8msg:ReceivedNo>15</v8msg:ReceivedNo>
   </v8msg:Header>
   <v8msg:Body>
      <!— Тело сообщения -->
   </v8msg:Body>
</v8msg:Message>

Всё сообщение находится внутри элемента XML с именем Message, относящимся к пространству имен http://v8.1c.ru/messages. Сообщение состоит из:

• заголовка — Header;
• тела сообщения — Body.

Тело сообщения содержится в элементе XML с именем Body, относящимся к пространству имен http://v8.1c.ru/messages. Данный элемент может иметь произвольное содержимое, определяемое прикладными потребностями. Инфраструктурой сообщений содержимое тела сообщения никак не регламентируется.

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

метод ЗаписатьСообщениеОбмена(КодУзлаПолучателя : Строка, ИмяФайла : Строка)
    пер Узел = УдаленныеСклады.НайтиПоКоду(КодУзлаПолучателя)
 
    пер ФайлСообщенияОбмена = новый Файл(ИмяФайла)
    пер ЗаписьXml = новый ЗаписьXml(ФайлСообщенияОбмена.ОткрытьПотокЗаписи())
    исп ОбработкаИсходящегоСообщения = УдаленныеСклады.СоздатьОбработкуИсходящегоСообщения(ЗаписьXml,  Узел)
     
        // Заполнение тела сообщения
        для Данные из УдаленныеСклады.ВыбратьИзмененияВСообщение(Узел, НомерСообщения)
           // Запись данных, делает разработчик проекта
            ЗаписатьДанныеВСообщениеОбмена(ОбработкаИсходящегоСообщения, Данные)
       ;
 ;

Завершить запись сообщения можно с помощью трех методов объекта ОбработкаИсходящегоСообщенияОбмена:

• Завершить()

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

• Отменить()

  Прерывает запись сообщения. Сообщение при этом считается неотправленным. Запись сообщения обмена может быть завершена либо обращением к методу Завершить(), либо обращением к методу Отменить().

• Закрыть() (вызывается автоматически при выходе из области видимости)

  Выполняется метод Отменить(), если закрытие произошло из-за выброса исключения. В ином случае выполняется метод Завершить()

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

метод ПрочитатьXmlСообщениеОбмена(Отправитель: Склады.Ссылка, ПотокФайла: ПотокЧтения)
    знч ЧтениеXml = новый ЧтениеXml(ПотокФайла)
    исп ГрупповаяОперация.Начать(РежимЗагрузкиДанных = Истина)
    // TODO убрать после отладки ДопустимыйНомерСообщения.Любой
    исп ОбработкаВходящегоСообщенияОбмена = Склады.СоздатьОбработкуВходящегоСообщения(ЧтениеXml, 
                                                                                       ДопустимыйНомерСообщения.Больший)
    знч ОтправительСсылка = ОбработкаВходящегоСообщенияОбмена.Отправитель как Склады.Ссылка
    если ОтправительСсылка != Отправитель
        выбросить новый ИсключениеНедопустимоеСостояние("Отправитель в сообщении отличается от отправителя каталога")
    ;
    Склады.УдалитьРегистрациюИзмененийПоСообщению(ОтправительСсылка, ОбработкаВходящегоСообщенияОбмена.НомерПринятого)
    пока ЧтениеXml.ВидУзла == ВидУзлаXml.НачалоЭлемента
        ПрочитатьИзменениеДанных(ЧтениеXml, ОтправительСсылка)
    ;
;    

Регистрация изменений может выполняться для следующих элементов проекта:

• Регистр сведений.
• Справочник.

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

• Элемент с именем MessageNo, который содержит номер данного сообщения.
• Элемент с именем ReceivedNo, который содержит максимальный номер сообщения, которое узел-отправитель данного сообщения принял от узла-получателя данного сообщения. Данное значение включено в состав заголовка сообщения для подтверждения приема сообщений.

Элемент проекта План Обмена также предоставляет следующую функциональность и логику работы с данными:

Порождаемые типы встроенного языка

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

Таблица языка запросов

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

Реквизиты плана обмена

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

Совет: Реквизиты плана обмена могут реализовывать контракт типа и контракты сущности.

Множественные реквизиты

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

Табличная часть

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

Хранение двоичных данных

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

Представление элемента

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

Поиск узлов при вводе по строке

Во время работы приложения, чтобы выбрать один из узлов плана обмена, пользователь может просто начать вводить в поле ввода известный ему фрагмент названия, кода или другого реквизита плана обмена. «1С:Шина» автоматически подберет ему подходящие элементы. Вы можете задать список тех реквизитов плана обмена, в которых «1С:Шина» будет искать текст, введенный пользователем

Индексы базы данных

Для того чтобы запросы к данным выполнялись быстро, «1С:Шина» стандартно создает в СУБД для таблицы, хранящей данные плана обмена, один индекс: по полю Ссылка. Этот индекс удобны в общем случае, но может не подходить для конкретных операций поиска и чтения элементов плана обмена в вашем приложении. Тогда вы можете описать в проекте, какие дополнительные индексы «1С:Шина» должен создать в таблицах плана обмена

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

Во время работы приложения «1С:Шина» автоматически генерирует все команды и формы, которые требуются для работы с элементами (узлами) плана обмена. Однако они могут не подходить вам в каких-то сложных или особенных случаях. Тогда вы можете создать собственные формы и указать, в каких ситуациях их должна использовать «1С:Шина» для работы с элементами (узлами) этого плана обмена

Права

Элемент проекта вида План Обмена обладает следующими правами: Создание, Чтение, Изменение и Удаление (подробнее).

События ВычислитьРазрешенияДоступа и ВычислитьРазрешенияДоступаДляОбъектов следует обрабатывать в модуле плана обмена

Дополнительные пространства управляемых блокировок

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

Запись данных в оптимизированном режиме

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

Все свойства плана обмена

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