1с создать xml на основе xsd пример
XDTO - это аббревиатура, обозначающая обмен данными посредством XML (XML Data Transfer Objects). Аббревиатура придумана разработчиками 1с и вряд ли встретится где-то ещё. Но реализует она вполне стандартизированный механизм обмена информацией с помощью файлов XML, известный как XML Schema.
Суть этого механизма заключается в том, что создаётся специальный файл, называемый схемой. Этот файл описывает структуру XML-файла. Если XML-файл соответствует этой структуре, то он считается корректным. Отдающей стороне достаточно сформировать корректный XML-файл для успешного обмена. Принимающая сторона должна гарантировать, что любой корректный XML-файл будет загружен без ошибок. В результате достаточно легко можно обеспечить обмен между двумя и более закрытыми информационными системами. Каждая схема характеризуется пространством имён, которое должно быть уникальным. Оно связывает XML-файл со своей схемой.
Самым ярким примером использования такого механизма обмена являются различного рода декларации (налоговые и прочее). На сайтах соответствующих ведомств всегда можно найти файл со схемой. Другой распространённый пример - обмен данными с сайтом.
С точки зрения программиста 1с, объект XDTO очень похож на Фиксированную структуру, созданную на основе файла со схемой. Эта псевдоструктура может быть загружена из XML-файла и использована для загрузки сторонних данных. А может быть заполнена данными и записана в корректный XML-файл. Который впоследствии будет использован для загрузки в другую информационную систему. В любом случае работа с объектом состоит из 3 основных этапов: получение типа объекта, создание объекта XDTO требуемого типа, использование объекта XDTO для выгрузки или загрузки данных.
Получение типа объекта
Это наиболее трудный для понимания этап т.к. он не соответствует обычной работе с переменными 1с. Но для работы с объектами XDTO он обязателен. Прежде чем создать объект XDTO, необходимо получить его тип. Для этого используются специальные объекты - фабрики типов XDTO.
Платформа позволяет использовать 2 вида схем - встроенные в конфигурацию XDTO-пакеты или внешние файлы с расширением .xsd и оформленные в соответствии со стандартами w3c. Соответственно, существует 2 способа получения объекта-фабрики типов.
Использование XDTO-пакетов
XDTO-пакет - это отдельный объект конфигурации, расположенный в ветке Общие дерева конфигурации. Платформа позволяет создавать неограниченное количество XDTO-пакетов как с помощью конструктора, так и путём импорта существующих файлов .xsd. Эти пакеты могут служить основой для получения типов объектов XDTO. Выглядит это так:
Здесь ФабрикаXDTO - это особый глобальный объект, который знает всё обо всех объектах XDTO, описанных в имеющихся в конфигурации XDTO-пакетах. Метод Тип() возвращает искомый тип объекта XDTO (ТипОбъектаXDTO). Он принимает 2 параметра - пространство имён и имя типа (оба - строки). Результат полезно запомнить в переменной, в дальнейшем её можно использовать для создания объектов XDTO произвольное количество раз.
Заметим, что в параметре передаётся не имя пакета, а его пространство имён. Имя пакета вообще нигде не используется и задаётся только для удобства поиска в дереве конфигурации.
Использование файлов с описанием схемы XML
Такие файлы традиционно имеют расширение .xsd. Преимущество данного метода в том, что он работает независимо от конфигурации. И если первому методу обязательно требуется отдельный объект конфигурации, этот требует только наличия файла со схемой. Вот код создания соответствующего объекта-фабрики и получение типа объекта XDTO:
Здесь мы использовали глобальную функцию СоздатьФабрикуXDTO, которая считывает файл со схемой (параметр функции) и создаёт объект-фабрику. Этот объект в будущем может произвольное число раз использоваться для создания любых доступных в схеме типов объектов. Если требуется загрузить несколько файлов со схемами, можно передать массив строк с именами файлов. Дальнейшая работа с фабрикой объектов не отличается от описанного в 1 способе.
Создание объекта XDTO
Сами объекты XDTO также создаются фабрикой объектов. Причём той же самой, которая использовалась при получении типа. Но используется уже другой метод - Создать():
В результате в переменной Номенклатура окажется объект XDTO, описанный в файле-схеме. К его реквизитам можно обращаться наподобие реквизитов фиксированной структуры. Естественно, нельзя добавлять или удалять реквизиты. В отличие от фиксированной структуры, каждый реквизит имеет определённый тип, поэтому произвольное присваивание не получится. Объект имеет тип ОбъектXDTO.
Запись объектов XDTO в файл
Прежде чем записать объект, его нужно заполнить. Принципы заполнения схожи с заполнением фиксированной структуры для реквизитов базовых типов, и с созданием объекта XDTO для прочих реквизитов.
Заполнение объекта XDTO
Использование фабрики объектов на этом не закончится. Ведь у переменной Номенклатура есть несколько реквизитов, и каждый из реквизитов относится к какому-то типу. К счастью, простые типы можно использовать без подобных преобразований простым присваиванием:
Более сложные типы требуют обращения к фабрике объектов:
Стандарт позволяет создавать реквизиты-списки и реквизиты-структуры без создания отдельных типов. Заполнять такие реквизиты можно следующим образом:
Здесь мы получаем объект-список методом ПолучитьСписок() объекта XDTO. Объект-список имеет тип СписокXDTO.
Получение типа элементов-структур немного напоминает работу с метаданными конфигурации. Используем метод Свойства() для получения списка реквизитов (КоллекцияСвойствXDTO). Далее получаем параметры реквизита методом списка Получить() (СвойствоXDTO). В его реквизите Тип и находится искомый тип значения.
Сейчас объект заполнен и его можно записать.
Запись объекта XDTO
Для записи воспользуемся объектом типа ЗаписьXML. В него умеет писать фабрика объектов с помощью метода ЗаписатьXML().
В результате в переменной Результат будет следующее содержимое:
Первая строка была добавлена методом ЗаписатьОбъявлениеXML() объекта ЗаписьXML. Остальное сделала фабрика. Из интересных моментов можно отметить наличие пары дополнительных пространств имён помимо используемого нами. В них описываются базовые типы реквизитов, таких как строка.
Если требуется результат записать сразу в файл, можно воспользоваться соответствующими методами объекта ЗаписьXML.
Чтение объектов XDTO из файла
Процесс чтения проще чем процесс записи. Сначала выполняем непосредственно чтение с помощью объекта ЧтениеXML и метода ПрочитатьXML() фабрики:
Как видим, ПрочитатьXML() требует в качестве параметра указания типа принимаемого XDTO-объекта. Параметр не обязательный, при его отсутствии метод попытается сам определить тип объекта. В результате в переменную НоменклатураСчитанная поместится объект, аналогичный записанному ранее.
В последней строке кода мы воспользовались методом Проверить() объекта XDTO. Этот метод вызовет исключение, если считанный объект не соответствует схеме XML. Рекомендуется этот метод вызывать и непосредственно перед записью объекта, чтобы гарантировать что сохранённый файл будет корректным.
Обращение к реквизитам аналогично обращению к реквизитам фиксированных структур. Для реквизитов-списков можно воспользоваться итератором:
Разумеется, содержимое считанного объекта можно менять. Впоследствии он может быть сохранён.
Добрый день, коллеги! Наконец-то дошли руки написать сию статью. Хочу поделиться своим опытом по разбору xsd схемы используя Фабрику XDTO, а также связанным с этим XML файлом. Думаю, наверняка кому-то понадобится.
Все будет сухо, без лирики и т.п.
Итак. Мне принесли задание. Подружить 1С с внешним сервисом по приему отчетности в виде xml файла.
Сторонний сервис имеет свой API по приему файлов, на выходе выдает некий код «батч», по которому я смогу вызвать еще одну функцию и получить по этому батчу, всю развернутую информацию по ошибкам.
Файл схема xsd небольшая, но типов данных много, на основе этой схемы полностью сформированный XML файл занимает что-то около 200Мб.
Дали ссылку на сайт, где можно узнать все остальное. Показывать ссылку не имеет смысла, т.к. доступ только после авторизации.
В итоге я имел на руках некий файл с расширением «xsd».
На тот момент я даже понятия не имел, что это и с чем и как его едят.
Дали какие-то пароли, логины, ссылку, куда все это выкладывать, и дали срок 3 недели.
Очень помог Инфостарт (не без этого, конечно, – огромное спасибо).
Для начала ниже материал, которым я пользовался, пока не завершил этот мини проект, и поэтому вот ссылки вам в помощь, которые могут понадобиться в дальнейшем, я думаю, это «маст-хэйв» для тех, кто хочет обучиться правилам XDTO:
-
Есть файл с правилами, ниже показана картинка в компактном виде, весь xsd файл можно увидеть во вложении.
Рис.1
Скажу, что на момент, когда я получил данный файл, я мог кое-как создавать типы XDTO. Читал статью «XDTO это просто» (все три части, конечно, не всё вкурил, как без этого).
И в итоге умел примерно такое:
Рис.2
(вырезка из другого кода)
То есть я мог создать тип «объектXDTO, если этот тип был расположен в дереве импортированной схемы в ветке «Типы объектов».Но на рисунке 1 выше видно, что все важные данные создаются только через ветку «свойства».
Рис.3
К примеру, на рис.3 видно, что у свойства «FirstName» один параметр «Name» является типом, ссылка на которую уводит в ветку «Типы объектов», а уже таааам указывается, что это за тип и что он в себе еще дополнительно содержит.
Рис.4
Как быть?
Что делать?
Как их прочитать?
Как на их основе мне создать тип «ОбъектXDTO», ведь через создать запись можно только если записываемый/создаваемый тип является типом «ОбъектXDTO»?
Что только не приходилось делать… я же умел создавать и записывать значения только если требуемые расположены в ветке «Типы объектов».
Даже дошел до того, что попробовал изменить схему.
Всё, что находилось в ветке «Свойства», я начал переносить в ветку «Типы объектов», начал создавать «туеву хучу» неправильных вещей, в итоге пришлось бросить весь гемор, пойти перекурить, и искать новые способы.
Попробовал все тестировать в «Liquid XML» - не получилось.
Потом попробовал все в «Visual Studio» - тоже …
Очень много звонил разработчикам этих схем, где им, наверное, думалось – «Вот чудик, он что, не знает про SOAP-ы, это же допотопный механизм обмена, странные он вопросы задает, хмм…» (кстати им тоже спасибо. открыли глаза 1С-нику).
В итоге.
В начале скажу, что у меня по условиям сбора данных есть некий первичный справочник список, в котором есть много реквизитов, которые необходимы для этого файла.
Данные собираются, фильтруются сортируются и в итоге я получаю готовую Таблицу значений.
Далее прохожу циклом эту таблицу и заполняю соответствующие реквизиты.
Итак, как я начал считывать XSD и создавать XML файлы.
Вначале считал пакет
Рис.5
Получил пакет в таком виде.
Рис.6
Далее мне нужно найти и спозиционироваться на свойстве «Records»
Вот она в дереве
Рис.7
Как это делается?
Скажу, что это как магия.
Пишем:
Рис.7
И мы получаем то значение, которое потом можем превратить в тип «ОбъектXDTO»
Рис.8
Получаем на выходе готовый нам нужный тип и делаем с ним все, что нужно.
К примеру, я должен пройтись циклом по реквизитам полученного объекта.
Просьба смотреть «не в воду», а в суть.
Тут главные строки это:
И т.д. далее, пока не получите что хотели.
Для получения каких-либо реквизитов свойства в схеме xsd пользуюсь такой конструкцией кода,
Но скажу, что видел и другие способы, тут, как говорится, дело ваше.
Результат рисунков с 7 по 12
Выглядит вот так в готовом файле:
И вот что я заметил (ну местные гуру, может, и знают давным-давно).
Это как бы и правила, и пометка.
Рассмотрим свойство «ContractCode»
Вот его описание:
Если это свойство имеет форму как «Элемент», то тогда код выглядит таким:
Т.е. я срази пишу значение в параметр, просто «= равно» и пошел.
Если свойство имеет форму как «Элемент», но он записан через знак «+»
То его код выглядит немного иначе
Т.е. нужно сначала создать через фабрику этот тип, получить его подчиненные подтипы и уже им присваивать значения из ваших данных.
И в итоге получается вот что.
Если в схеме это свойство имеет форму «элемент»
То в готовом файле запишется такая запись:
Т.е. все будет записано внутри т.н. «тегов».
Далее если вы имеете в схеме такую связку значений и ее свойства:
Т.е. у свойства «FundingType» есть подчиненный элемент «id», где его форма равна «Атрибут»
В этом случае код при написании НЕ изменится:
Замечу, что этот код похож на рис.16
Воот, а результат будет немножко другой:
Т.е. значение запишется сразу в сам «тег».
Есть такое свойство, как «Gender»
Он в свою очередь имеет ссылку на другой тип:
А вот сам тип «GenderType»
Вот его свойства:
Тут говорится, что данный тип значения в целом равен типу «string», но он вариант у него «атомарный», т.е. имеет, скажем, «перечисление». И его перечисления, это
Аналогично и с «F»
Теперь дилемма, как мне его получить и как его записать.
Вот ответ (сам искал полдня):
Тут весь фокус в строке
Советую почитать про «Фасеты». Там все просто.
Ну и в завершение.
Собираем файл этими строками:
Тут лишь в конце стоит сказать один момент.
Принимающая сторона не передала значение «xmlns», пришлось ее искать и вписывать в начало файла, вот пример:
Есть очень много статей о том, как работать с XSL/XSD из 1С, но все они в стиле: возьмем нашу XSD схему (простую и удбоную) или наш web-сервис и смотрите, как все легко экспортировать или импортировать. А что делать, если нам дали пачку XSD-схем со сложным взаимосвязями и изменять мы них не можем, а работать и поддерживать актуальность схем надо?
Сразу скажу, вопросы шифрования/подписи по ГОСТУ при работе с ГИС ЖКХ за рамками этой статьи и на хабре уже освещались. Хотя без подписей запросы выполнить не удастся.
Начнем с простого — скачаем пакет форматов по интеграционному взаимодействию с ГИС ЖКХ, импортируем все xsd схемы из пакета интеграций, наведем порядок переименуем все как нам удобно. В итоге получим как показано на картинке:
Ну а теперь приступим к магии. Попробуем запросить данные из справочника организаций по ОРГН. Это подсистема organizations-registry-common метод exportOrgRegist.
В hcs-organizations-registry-common-service.wsdl указано:
Надо собрать SOAP пакет из заголовка ISRequestHeader, тела exportOrgRegistryRequest. Посмотрим их в xsd схемах спецификаций по интеграций.
Ну приступим, откроем нужные нам пакеты XDTO. Оказывается, нужные сущности являются не типами, а свойствами, как с этим работать в документации на XDTO в статьях, которые я находил, не описано, поэтому воспользуемся урокам магии:
Начнем с тела exportOrgRegistryRequest.
Напишем функцию для сбора XML-запроса:
В итоге получим запрос:
Ответ от серверов ГИС ЖКХ (СИТ-1):
Как мы видим, ответ напрямую десериализовать не получится, потому что нет такого типа в предложенных xsd схемах. Нам надо как-то пропустить часть тэгов и обработать только область ответа. На эту тему я тоже не нашел информации, но методом проб и ошибок приходим к кусочку магий:
В итоге работать можно с очень сложными xsd схемами через стандартные инструменты платформы. В целом 1С контролируют типизацию и заполнения, бывает чересчур излишне, особенно когда внутри свойства пакета используется базовый тип другого пакета, но в любом случае тип нужно привести к локальному из-за другого пространства URI. Удобно работать с десериализоваными данными, так как там всю работу на себя берет платформа. Но проверки происходят на этапе выполнения, а при написания кода платформа 1С не предоставляет никаких подсказок и проходится пользоваться сторонними утилитами, и даже при выполнении большая часть элементов находится в состоянии «Неопределено» и даже тип или его свойство можно увидеть только в спецификации.
XSD — это язык описания структуры XML документа. Его также называют XML Schema. При использовании XML Schema XML парсер может проверить не только правильность синтаксиса XML документа, но также его структуру, модель содержания и типы данных.
Такой подход позволяет объектно-ориентированным языкам программирования легко создавать объекты в памяти, что, несомненно, удобнее, чем разбирать XML как обычный текстовый файл.
Кроме того, XSD расширяем, и позволяет подключать уже готовые словари для описания типовых задач, например веб-сервисов, таких как SOAP.
Стоит также упомянуть о том, что в XSD есть встроенные средства документирования, что позволяет создавать самодостаточные документы, не требующие дополнительного описания.
Рассмотрим в качестве примера XSD документ, описывающий часть структуры аккаунта на хабре.
Текст XSD схемы и XML документ, соответствующий этой схеме я не стал включать в статью из-за их размера.
Первая строчка схемы указывает, что документ является XML документом и использует кодировку UTF-8.
Тег описывает «сложный» тип данных user_name. При желании его можно вынести как отдельный тип данных, по аналогии с contact_info. Для этого, нужно блок перенести в и указать атрибут name, а элементу задать атрибут type.
Элементы user_name, first_name, last_name имеют строковый тип и описывают пользователя, имя и фамилию владельца аккаунта.
Элемент date_of_birth имеет тип данных «дата» и описывает дату рождения.
Дату регистрации описывает register_date, имеющий собственный тип данных customDateTime. Значение этого тега будет задаваться с помощью атрибута value. На это указывают строки.
В таком случае длина строки будет всегда 19, это задано тегом и само значение будет соответствовать шаблону, указанным в теге .
Элементы contact_info и blog — массивы, на это указывает атрибут maxOccurs=«unbounded».
Тег определяет то, что вложенным элементом будет один из элементов ICQ или linkedin.
Тег указывает на то, что вложенные элементы будут blog_name и blog_url именно в такой последовательности. Если последовательность не важна, то нужно использовать тег .
Дополнительно о XSD схемах можно почитать Wikipedia и W3C. Для создания макета была использована программа Altova XMLSpy.
Добрый день, коллеги!
Наконец-то дошли руки написать сию статью.
Хочу поделиться своим опытом по разбору xsd схемы используя Фабрику XDTO, а также связанным с этим XML файлом.
Думаю, наверняка кому-то понадобится.
Все будет сухо, без лирики и т.п.
Итак. Мне принесли задание. Подружить 1С с внешним сервисом по приему отчетности в виде xml файла.
Сторонний сервис имеет свой API по приему файлов, на выходе выдает некий код «батч», по которому я смогу вызвать еще одну функцию и получить по этому батчу, всю развернутую информацию по ошибкам.
Файл схема xsd небольшая, но типов данных много, на основе этой схемы полностью сформированный XML файл занимает что-то около 200Мб.
Дали ссылку на сайт, где можно узнать все остальное. Показывать ссылку не имеет смысла, т.к. доступ только после авторизации.
В итоге я имел на руках некий файл с расширением «xsd».
На тот момент я даже понятия не имел, что это и с чем и как его едят.
Дали какие-то пароли, логины, ссылку, куда все это выкладывать, и дали срок 3 недели.
Очень помог Инфостарт (не без этого, конечно, – огромное спасибо).
Для начала ниже материал, которым я пользовался, пока не завершил этот мини проект, и поэтому вот ссылки вам в помощь, которые могут понадобиться в дальнейшем, я думаю, это «маст-хэйв» для тех, кто хочет обучиться правилам XDTO:
-
Есть файл с правилами, ниже показана картинка в компактном виде, весь xsd файл можно увидеть во вложении.
Рис.1
Скажу, что на момент, когда я получил данный файл, я мог кое-как создавать типы XDTO. Читал статью «XDTO это просто» (все три части, конечно, не всё вкурил, как без этого).
И в итоге умел примерно такое:
Рис.2
(вырезка из другого кода)
То есть я мог создать тип «объектXDTO, если этот тип был расположен в дереве импортированной схемы в ветке «Типы объектов».Но на рисунке 1 выше видно, что все важные данные создаются только через ветку «свойства».
Рис.3
К примеру, на рис.3 видно, что у свойства «FirstName» один параметр «Name» является типом, ссылка на которую уводит в ветку «Типы объектов», а уже таааам указывается, что это за тип и что он в себе еще дополнительно содержит.
Рис.4
Как быть?
Что делать?
Как их прочитать?
Как на их основе мне создать тип «ОбъектXDTO», ведь через создать запись можно только если записываемый/создаваемый тип является типом «ОбъектXDTO»?
Что только не приходилось делать… я же умел создавать и записывать значения только если требуемые расположены в ветке «Типы объектов».
Даже дошел до того, что попробовал изменить схему.
Всё, что находилось в ветке «Свойства», я начал переносить в ветку «Типы объектов», начал создавать «туеву хучу» неправильных вещей, в итоге пришлось бросить весь гемор, пойти перекурить, и искать новые способы.
Попробовал все тестировать в «Liquid XML» — не получилось.
Потом попробовал все в «Visual Studio» — тоже …
Очень много звонил разработчикам этих схем, где им, наверное, думалось – «Вот чудик, он что, не знает про SOAP-ы, это же допотопный механизм обмена, странные он вопросы задает, хмм…» (кстати им тоже спасибо. открыли глаза 1С-нику).
В итоге.
В начале скажу, что у меня по условиям сбора данных есть некий первичный справочник список, в котором есть много реквизитов, которые необходимы для этого файла.
Данные собираются, фильтруются сортируются и в итоге я получаю готовую Таблицу значений.
Далее прохожу циклом эту таблицу и заполняю соответствующие реквизиты.
Итак, как я начал считывать XSD и создавать XML файлы.
Вначале считал пакет
Рис.5
Получил пакет в таком виде.
Рис.6
Далее мне нужно найти и спозиционироваться на свойстве «Records»
Вот она в дереве
Рис.7
Как это делается?
Скажу, что это как магия.
Пишем:
Рис.7
И мы получаем то значение, которое потом можем превратить в тип «ОбъектXDTO»
Рис.8
Получаем на выходе готовый нам нужный тип и делаем с ним все, что нужно.
К примеру, я должен пройтись циклом по реквизитам полученного объекта.
Просьба смотреть «не в воду», а в суть.
Тут главные строки это:
И т.д. далее, пока не получите что хотели.
Для получения каких-либо реквизитов свойства в схеме xsd пользуюсь такой конструкцией кода,
Но скажу, что видел и другие способы, тут, как говорится, дело ваше.
Результат рисунков с 7 по 12
Выглядит вот так в готовом файле:
И вот что я заметил (ну местные гуру, может, и знают давным-давно).
Это как бы и правила, и пометка.
Рассмотрим свойство «ContractCode»
Вот его описание:
Если это свойство имеет форму как «Элемент», то тогда код выглядит таким:
Т.е. я срази пишу значение в параметр, просто «= равно» и пошел.
Если свойство имеет форму как «Элемент», но он записан через знак «+»
То его код выглядит немного иначе
Т.е. нужно сначала создать через фабрику этот тип, получить его подчиненные подтипы и уже им присваивать значения из ваших данных.
И в итоге получается вот что.
Если в схеме это свойство имеет форму «элемент»
То в готовом файле запишется такая запись:
Т.е. все будет записано внутри т.н. «тегов».
Далее если вы имеете в схеме такую связку значений и ее свойства:
Т.е. у свойства «FundingType» есть подчиненный элемент «id», где его форма равна «Атрибут»
В этом случае код при написании НЕ изменится:
Замечу, что этот код похож на рис.16
Воот, а результат будет немножко другой:
Т.е. значение запишется сразу в сам «тег».
Есть такое свойство, как «Gender»
Он в свою очередь имеет ссылку на другой тип:
А вот сам тип «GenderType»
Вот его свойства:
Тут говорится, что данный тип значения в целом равен типу «string», но он вариант у него «атомарный», т.е. имеет, скажем, «перечисление». И его перечисления, это
Аналогично и с «F»
Теперь дилемма, как мне его получить и как его записать.
Вот ответ (сам искал полдня):
Тут весь фокус в строке
Советую почитать про «Фасеты». Там все просто.
Ну и в завершение.
Собираем файл этими строками:
Тут лишь в конце стоит сказать один момент.
Принимающая сторона не передала значение «xmlns», пришлось ее искать и вписывать в начало файла, вот пример:
Читайте также: