Доступный состав стандартного интерфейса odata epf

Была реализована возможность автоматически формировать REST интерфейс OData для всего прикладного решения. Таким образом у нас появилась возможность предоставить полный доступ стороннему приложению к базе 1С буквально за пару кликов.

Данный механизм предназначен для решения нескольких часто встречающихся задач:

  • Выгрузка/загрузка данных в/из прикладного решения;
  • Интеграция с интернет-сайтами (интернет-магазинами);
  • Наращивание функциональности прикладного решения без изменения конфигурации;
  • Интеграция с другими корпоративными системами (иногда и без дополнительного программирования).

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

И это действительно удобно, если учесть, что клиенты OData существуют на всех основных платформах, соответствующие библиотеки можно скачать .

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

Публикация REST интерфейса OData

Для использования интерфейса OData его нужно опубликовать, а для этого нам потребуется веб-сервер — Apache 2.2 или IIS (начиная с версии еще и Apache 2.4). Затем, нужно зайти в меню «Администрирование»->»Публикация на веб-сервере…».

В открывшемся окне заполняем нужные поля и жмем «Опубликовать»:

После этого нужно будет определить состав интерфейса OData, т.е. указать — какие объекты конфигурации в него входят, а какие нет (изначально в составе нет ни одного объекта).

Сделать это можно примерно так:

&НаСервере Процедура УстановитьODataНаСервере() тМассив = Новый Массив; тМассив.Добавить(Метаданные.Справочники.Товары); УстановитьСоставСтандартногоИнтерфейсаOData(тМассив); КонецПроцедуры

&НаСервере

Процедура УстановитьODataНаСервере()

тМассив= Новый Массив;

тМассив. Добавить(Метаданные. Справочники. Товары) ;

УстановитьСоставСтандартногоИнтерфейсаOData(тМассив) ;

КонецПроцедуры


Обзор OData

OData — это веб-ориентированный API-интерфейс для доступа к данным и манипулирования ими. Он подобен API-интерфейсам mini-ODBC и JDBC, но в отличие от них специально ориентирован на Интернет. Точнее говоря, OData позволяет клиентам конструировать URI-идентификаторы для именования набора сущностей, осуществлять фильтрацию содержащихся в этом наборе сущностей, а также прослеживать отношения со связанными сущностями и коллекциями сущностей. Для получения дополнительной информации обратитесь к статье Introduction OData: Data Access for the Web, the cloud, mobile devices, and more (Представляем OData: доступ к данным с помощью Интернета, облачной среды, мобильных устройств и т. д.).

Рисунок 1. Выставление базы данных в Интернете с помощью OData-поставщика общего назначения

В схеме на рисунке 1 показано, как такой ресурс, как база данных, может быть выставлен в Интернете при посредстве OData-поставщика общего назначения. Синтаксис OData позволяет с помощью Web-браузеров подергать данные в вышеупомянутой базе данных различным манипуляциям (создание, обновление, удаление, запрос).

Рисунок 2. Язык CSDL (Conceptual Schema Definition Language)

На рисунке 2 показана схема языка CSDL (Conceptual Schema Definition Language). CSDL — это опциональный инструмент, помогающий приложениям-потребителям понимать структуру выставляемых данных. CSDL подобен метаданным в JDBC and ODBC, он помогает клиентским приложениям понимать, к чему именно они обращаются.

В Интернете имеются тысячи веб-ориентированных API-интерфейсов. OData — это один из примеров такого API-интерфейса. Более подробную информацию о веб-ориентированных API-интерфейсах можно получить на веб-сайте: Programmable Web . Стандартизация таких интерфейсов позволит улучшить консолидацию в этом важной технологической области и поможет инновациям идти в ногу с потребностями рынка, в частности поддерживать новые конструкции данных и инициативы в сфере открытых данных.

OData в организации OASIS

Проект хартии по OData был представлен в организацию OASIS (Organization for the Advancement of Structured Information Standards). Ниже приведен фрагмент текста из этого документа.

Работа будет ориентирована на достижение следующих целей.

  • Создание RESTful-сервисов данных на базе HTTP, возможность идентифицирования ресурсов с помощью URI-идентификаторов (Uniform Resource Identifier) и определения ресурсов с помощью абстрактной модели данных, возможность публикования и редактирования веб-клиентами с использованием простых HTTP-сообщений.
  • Выставление и получение информации из различных источников, включая, но не ограничиваясь, реляционные базы данных, файловые системы, системы управления контентом и традиционные веб-сайты.

Документы со спецификациями OData, представленные в организацию OASIS, а также проект хартии доступны по следующим ссылкам.

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

Эти документы с расширениями призваны инициировать работу в предлагаемом техническом комитете OASIS по OData (OASIS OData Technical Committee). На веб-сайте организации OASIS можно прочитать полный текст хартии по OData и документы с расширениями.

OData и продукты IBM

Следующие продукты IBM поддерживают OData.

  • Продукт для поддержки доступа со стороны различных клиентов.
  • Продукты DB2 и Informix способны использовать OData посредством Microsoft Visual Studio. Более подробная информация по этой теме содержится .

Примеры OData

В данном параграфе приведено несколько простых примеров на OData, обращающихся к сервису Netflix.

Default Genres Titles . . . . . . Titles http://odata.netflix.com/v2/Catalog/Titles/ 2012-05-23T21:41:18Z Lead singer Anthony Kiedis, bassist Flea, ... 2012-01-31T09:45:16Z . . . http://odata.netflix.com/v2/Catalog/Titles("13aly") Red Hot Chili Peppers: Funky Monks Lead singer Anthony Kiedis, bassist Flea, drummer Chad Smith ... 2012-01-31T09:45:16Z . . . 13aly Red Hot Chili Peppers: Funky Monks Red Hot Chili Peppers: Funky Monks Lead singer Anthony Kiedis, bassist Flea, drummer Chad Smith ... 3.4 1991 . . .

OData и другие веб-ориентированные API-интерфейсы

В настоящее время используются тысячи веб-ориентированных API-интерфейсов. К числу популярных API-интерфейсов этой категории относятся картографические сервисы . По состоянию на июнь 2012 года на веб-сайте Programmable Web было перечислено более 6000 веб-ориентированных API-интерфейсов (см. заметку под названием: API Business Models Take Center Stage). Недавнее исследование компании Vordel показало, что "половина предприятий внедряет API-интерфейсы для построения новых бизнес-каналов", при этом 25% из этих интерфейсов разрабатывается специально для мобильных приложений.

Одна из интересных областей – какое отношение имеет OData к деятельности в области API-интерфейса Linked Data. Рабочая группа W3C Linked Data Platform (LDP) Working Group и технический комитет OASIS OData Technical Committee стремятся специфицировать API-интерфейсы REST-типа для получения данных и манипулирования ими в Интернете с использованием различных моделей данных. Платформа LDP базируется на модели данных была специфицирована компаний Microsoft и берет свое начало в модели Peter Chen"s Entity Relationship Model сформулированной в 1976 г. (Peter Chen). Модель EDM до сих пор используется при проектировании реляционных баз данных. Модель данных EDM базируется на преобразовании информации в сущности и в отношения. Эта модель использует специфические для определенной области значения, например, номера социального страхования, номера счетов-фактур, номера товаров, для ссылки на ресурсы и на их свойства, а также для связывания информации.

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

Построение адаптеров между гетерогенными веб-ориентированными API-интерфейсами вполне возможно. К примеру, прототип адаптера для связывания рабочих элементов (workitem) решения , получаемых посредством API-интерфейс на базе Linked Data под названием OSLC (Open Services for Life Cycle Collaboration) , и документов Microsoft Sharepoint, получаемых посредством OData, можно найти по следующей ссылке: http://wiki.eclipse.org/Lyo/SharepointAdapter .

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

Благодарности

Выражаю глубокую благодарность за отзывы и предложения моим коллегам: Elizabeth Cleary, Andrew Eisenberg, Diane Jordan, Arnaud Le Hors.

Печать (Ctrl+P)

Вторая часть можно посмотреть

Общие сведения

В версии платформы 8.3.5.1068 , опубликованной в сентябре 2015 появился механизм интеграции 1С с внешними программами через технологию REST интерфейс . В качестве протокола доступа платформа использует протокол OData . Это открытый веб-протокол для запроса и обновления данных. Он позволяет оперировать данными, используя в качестве запросов HTTP-команды. Получать ответы в версии 8.3.5.1068 можно было только в формате Atom/XML . Однако, начиная с релиза 8.3.8.1652 в августе 2017 г. появился второй вариант получения данных в формате JSON(англ. JavaScript Object Notation) . По сравнению с XML он легко читается людьми занимает меньше места. Кроме этого все браузеры имеют встроенные средства для работы с JSON.

Работу с протоколом OData на платформе 1С: предприятие можно посмотреть в книге 1С: Руководства разработчика в главе 17 Механизмы интернет-сервисов , параграф 17.2.1 Cтандартный интерфейс OData. Можно также посмотреть примеры расширения поддержки протокола OData ,

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

Публикация стандартного интерфейса OData выполняется с помощью диалога публикации на веб-сервере (Администрирование – Публикация на веб- сервере) и описано в книге 1С:Предприятие 8.3. “Руководство администратора”.
Важно! Для того чтобы объекты конфигурации стали доступны через стандартный интерфейс OData, необходимо разрешить это с помощью метода глобального контекста УстановитьСоставСтандартногоИнтерфейсаOData() .
Механизм установки состава объектов, доступных с помощью стандартного интерфейса OData, можно выполнить в виде внешней обработки. Для этого не требуется модифицировать прикладное решение.

Для взаимодействия с внешним REST- веб-сервер из 1С:Предприятия используется имеющиеся в платформе средства работы с HTTP: объекты HTTPСоединение, HTTPЗапрос и HTTPОтвет.

В этой цикле статьей я буду показывать примеры типовых операций, использующих соответствующий HTTP-метод;

  • Получение данных – метод GET ;
  • Создание объекта – метод POST ;
  • Обновление данных: метод PATCH – в этом случае можно указывать только те свойств, которые необходимо обновить; метод PUT – в этом случае необходимо указывать все свойства сущности;
  • Удаление данных – метод DELETE .

1. Примеры получения данных. HTTP-метод GET

В качестве сервера будет выступать опубликованная на веб-сервере БД с именем WebBuh (Демо-база “Бухгалтерия Предприятия 3.0”). В качестве формата обмена данных я буду использовать формат JSON. Подробнее о работе с JSON написано в документации, доступной . Для получения данных из сервера HTTP-методом GET требуется создать объект ЧтениеJSON для последовательного чтения JSON-данных из файла или строки. Для организации последовательной записи объектов и текстов на сервере HTTP-методом POST PATCH PUT требуется создать объект ЗаписьJSON. Отметим, для метода DELETE не требуется JSON.

В качестве иллюстрации потокового чтения и записи JSON при обращении к REST интерфейсу я буду вызывать следующую пользовательскую функцию общего назначения ВызватьHTTPМетодНаСервере :

&НаСервере // <Описание функции> // // Параметры: // - Строка, содержащая имя HTTP-метода для запроса ("POST"."PATCH", "PUT" ,"GET","DELETE" // - объект HTTPСоединение // <АдресРесурса> - Строка http-ресурса, к которому будет отправлен HTTP запрос. // <ОтправляемыеДанные> - Структура или соответствие, содержащие данные, отправляемые на указанный адрес для обработки // на сервер с использованием указанного HTTP-метода "POST" или "PATCH" или "PUT" // Возвращаемое значение: // Структура ответа сервера в зависимости от HTTPМетод // Функция ВызватьHTTPМетодНаСервере(HTTPМетод,HTTPСоединение,АдресРесурса,ОтправляемыеДанные = Неопределено ) // Создание HTTPЗапрос Заголовки = Новый Соответствие (); Заголовки.Вставить ("Content-Type", "application/json"); ЗапросHTTP = Новый HTTPЗапрос (АдресРесурса, Заголовки ); // ЗаписьJson толка для создания и обновление данных Если HTTPМетод = "POST" или HTTPМетод ="PATCH" или HTTPМетод ="PUT" Тогда ЗаписьJSON = Новый ЗаписьJSON ; ПараметрыJSON = Новый ПараметрыЗаписиJSON (ПереносСтрокJSON.Авто,"",Истина ); ЗаписьJSON.УстановитьСтроку (ПараметрыJSON ); ЗаписатьJSON(ЗаписьJSON , ОтправляемыеДанные ); // ОтправляемыеДанные обязательны в этом случае СтрокаДляТела = ЗаписьJSON.Закрыть (); ЗапросHTTP.УстановитьТелоИзСтроки (СтрокаДляТела ,КодировкаТекста.UTF8 , ИспользованиеByteOrderMark.НеИспользовать ); КонецЕсли; // Вызов Метода HTTPСоединение ОтветHTTP = HTTPСоединение.ВызватьHTTPМетод(HTTPМетод, ЗапросHTTP) ; СтруктураОтвета = Новый Структура ; СтруктураОтвета .Вставить ("КодСостояния ", ОтветHTTP.КодСостояния ); // ЧтениеJSON только для метода GET Если HTTPМетод= "GET" Тогда Попытка ЧтениеJSON = Новый ЧтениеJSON ; ОтветСервера = ОтветHTTP.ПолучитьТелоКакСтроку ("UTF-8"); ЧтениеJSON.УстановитьСтроку(ОтветСервера) ; Соответствие = ПрочитатьJSON(ЧтениеJSON ,Истина ); СтруктураОтвета.Вставить("ОтветСервера ", Соответствие ) ; СтруктураОтвета .Вставить ("ОтветСервераНеРасшифрованный ", ОтветСервера ); Исключение Сообщить(ОписаниеОшибки()) ; Возврат Неопределено; КонецПопытки; Конецесли ; Возврат СтруктураОтвета ; КонецФункции // ВызватьHTTPМетодНаСервере()

Для получения от сервера в формате JSON при обращении к REST интерфейсу прикладного решения нужно в адресе ресурса указать $format=json. Либо указать MIME тип “application/json” в заголовке:

Заголовки = Новый Соответствие (); Заголовки.Вставить("Content-Type", "application/json") ; АдресРесурса ="WebBuh /odata/standard.odata/?$format=json " ЗапросHTTP = Новый HTTPЗапрос(АдресРесурса, Заголовки) ;

Особенность глобального контекста ПрочитатьJSON(ЧтениеJSON, Истина )

  • Если значение второго параметра установлено Истина , чтение объекта JSON будет выполнено в Соответствие .Если установлено Ложь , объекты будут считываться в объект типа Структура .
  • При десериализации объектов JSON в структуру необходимо помнить о требованиях к ключам структуры. Если при десериализации объекта будет найдено имя свойства, недопустимое для ключа структуры, то будет вызвано исключение.

1. 1 Настройка параметров HTTP соединения

Для организации клиентской части взаимодействия с внешним REST- веб-сервер, я создал “с нуля” конфигурацию клиента на базе БСП. На этой конфигурации я создал справочник настройки параметров подключения (см Рис 1)

Рис 1 Справочник настройки параметров HTTP соединения к внешней ИБ через rest интерфейс

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

&НаКлиенте Процедура ПроверитьПодключение(Команда) Адрес = Объект.АдресСервера ; Пользователь = Объект.Пользователь ; Пароль = Объект.Пароль; ИмяБазы = Объект.Наименование ; Порт = ?(Объект.Порт <> 0,Объект.Порт,80) ; HTTPСоединение = Новый HTTPСоединение(Адрес,Порт,Пользователь, Пароль) ; АдресРесурса = ИмяБазы + "/odata/standard.odata/$metadata "; //Вызов пользовательской функции СтруктураОтвета = ВызватьHTTPМетодНаСервере ("GET" ,HTTPСоединение,АдресРесурса ) ; Если СтруктураОтвета <> Неопределено Тогда ОбщегоНазначенияКлиентСервер.СообщитьПользователю("Код состояния "+СтруктураОтвета.КодСостояния) ; Конецесли; КонецПроцедуры

Цель этой процедуры – Это проверка работы сервиса и правильно ли пользователь ввел параметры соединения. Для этого достаточно выполнить GET-запрос:
HTTPСоединение.ВызватьHTTPМетод(“GET” , ЗапросHTTP) ;
с использованием адреса ресурса:
АдресРесурса = ИмяБазы + /odata/standard.odata/ “;
Проверить работы сервиса можно также в браузере с использованием
URL
http://host/WebBuh/odata/standard.odata. В результате такого запроса получается только список сущностей. Для получения полного описания стандартного интерфейса OData (список доступных сущностей, их атрибутов и функций в виде XML-
документа.) необходимо выполнить GET-запрос с использованием параметра $metadata. URL http://host/WebBuh/odata/standard.odata/$metadata. Подробное описание документа можно получить по адресу http://www.odata.org/documentation/ (на английском языке).
Получать ответы можно в формате Atom/XML или JSON . Коды статусов ответа по протоколу HTTP можно посмотреть Ответы в диапазонах:

  • 100-199 – информационные ответы, показывающие, что запрос клиента принят и обрабатывается.
  • 200-299 – означают, что запрос клиента обработан успешно.
  • 300-399 означает, что запрос не выполнен и клиенту нужно предпринять некоторые действия для удовлетворения запроса.
  • 400-499 – информирует об ошибках на стороне клиентского приложения. Эти коды могут также означать, что от клиента требуется дополнительная информация.
  • 500-599 – информирует об ошибке на стороне сервера, показывают, что сервер столкнулся с ошибкой и, вероятно, не сможет выполнить запрос клиента.

1.2 Поиск объекта по идентификатору

Следующая функция предназначена для поиска справочника или документа по уникальному идентификатора на сервере. Если объект найден, то функция возвращает строковое значение идентификатора (Ref_Key) , иначе возвращает неопределено. В функцию передаются следующие параметры:

  • HTTPСоединение – Объект типа HTTPСоединение
  • ИмяПубликации – Имя опубликованной базы базы данных сервера
  • Элемент – идентификатор сущности объекта, например, Catalog_Организации или Document_- справочник Организации.
  • Идентификатор – Идентификатор объекта, который нужно искать на сервере, например, Организация.УникальныйИдентификатор()
&НаСервере Функция ПоискОбъектПоGUID (HTTPСоединение,ИмяПубликации,Элемент,УникальныйИдентификатор ) GUID = Строка(УникальныйИдентификатор ); // преобразуем в строку АдресРесурса = + Элемент+ "(guid""+ GUID+ "")?$format=json " ; СтруктураОтвета = В ызватьHTTPМетодНаСервере ("GET" , HTTPСоединение,АдресРесурса ) ; Если СтруктураОтвета .КодСостояния >= 400 Тогда //ОбщегоНазначенияКлиентСервер.СообщитьПользователю(Элемент+ " Ошибка "+СтруктураОтвета.КодСостояния+ //ОбщегоНазначенияКлиентСервер.СообщитьПользователю(СтруктураОтвета.ОтветСервераНеРасшифрованный); Возврат неопределено ; КонецЕсли ; Соответствие = СтруктураОтвета. ОтветСервер а; Массив = Соответствие["value"] ; Если Массив = Неопределено Тогда Возврат Соответствие ["Ref_Key"] Иначе Возврат Массив ["Ref_Key"]; КонецЕсли; КонецФункции

Параметр АдресРесурса используется для обращения к REST-сервису. Для проверки работы сервиса можно указать ресурс в браузере таким образом

http://{АдресВебСервера}/{ИмяПубликации}/odata/standard.odata/{Элемент}?{Параметры} ,где

  • АдресВебСервера – Адрес веб-сервера, на котором опубликован сервис, например Localhost
  • ИмяПубликации – имя информационной базы указанное при публикации решения
  • /odata/standard.odata/ – Признак обращения к стандартному интерфейсу OData
  • Элемент – идентификатор ресурса или предопределенные ресурсы. Например, Catalog_Контрагент(guid’value’).
  • Параметры – параметры ресурса. Используются, например, для отбора, в принятом для HTTP-запросов: ?ключ=значение&ключ2=значение2

1.3 Поиск объекта по полям поиска

Следующая пользовательская функция предназначена для поиска объекта по полям поиска в том случае, когда объект по идентификационному номеру. Функция возражает строку Ref_Key – идентификационный номер.

&НаСервере Функция П оискОбъектПоПолямПоиска(HTTPСоединение,ИмяПубликации, Элемент,ПоляПоиска) Условие = "" ; Для Каждого КлючЗначение из ПоляПоиска Цикл Условие = Условие + КлючЗначение.Ключ + " eq "" + КлючЗначение.Значение + "" and "; КонецЦикла; ТекстЗапроса = Лев(Условие, СтрДлина(Условие)-5) ; // удаляем последние 5 символов АдресРесурса = ИмяПубликации+ "/odata/standard.odata/" +Элемент+ "?$filter=" + ТекстЗапроса + "&$format=json&$select=Ref_Key " ; //Вызов моей пользовательской функции СтруктураОтвета = ВызватьHTTPМетодНаСервере("GET " ,HTTPСоединение,АдресРесурса); Если СтруктураОтвета .КодСостояния >= 400 Тогда //ОбщегоНазначенияКлиентСервер.СообщитьПользователю(Элемент+ " Ошибка "+СтруктураОтвета.КодСостояния); //ОбщегоНазначенияКлиентСервер.СообщитьПользователю(СтруктураОтвета.ОтветСервераНеРасшифрованный); Возврат неопределено; КонецЕсли; Соответствие = СтруктураОтвета. ОтветСервер а; Массив = Соответствие["value" ] ; Если Массив = Неопределено Тогда Возврат Соответствие ["Ref_Key" ] Иначе Возврат Массив ["Ref_Key" ]; КонецЕсли; КонецФункции

Как видно из тела процедуры П оискОбъектПоПолямПоиска , отбор начинается с ключевого слова $filter в адресе ресурса. Формальный параметр ПоляПоиска – это соответствие, которое содержит наименования и значения реквизитов.

Отметим, что наименование реквизитов порой не очевидно. Необходимо запомнить, что для справочников:

  • Code – код,
  • Description – Наименование
  • DeletionMark – пометка удаления,
  • IsFolder – признак группы,
  • Parent_Key – родитель.
  • Если реквизит ссылочного типа, к его имени следует добавить суффикс _Key, например Контрагент_Key.

Для документов:

  • Number – номер документа,
  • Date – дата документа.

Логические операции отбора

  • eq - Равно; /Catalog_Города?$filter=Наименование eq ‘Главный’;
  • ne - Не равно; /Catalog_Города?$filter=Наименование ne ‘Пермь’;
  • gt - Больше; /Catalog_Товары?$filter= Цена gt 10;
  • ge - Больше или равно; /Catalog_Товары?$filter=Цена ge 10;
  • lt - Меньше; /Catalog_Товары?$filter=Цена lt 10;
  • le - Меньше или равно; /Catalog_Товары?$filter=Цена le 10;
  • or - Логическое ИЛИ; /Catalog_ Товары ?$filter= Цена lt 10 or Цена gt 100;
  • and - Логическое И; / Catalog _Товары?$ filter =Цена g t 10 and Цена l t 100;
  • not - Отрицание; /Catalog_ Товары ?$filter=not (Цена eq 10);

Отметим, также, что значение фактического параметра Элемент (или сущность)) , который я передаю на функцию формируется по следующему правилу:

ПрефиксИмени_ИмяОбъектаКонфигурации_СуффиксИмени .

С помощью стандартного интерфейса OData можно получить доступ к следующим объектам (ПрефиксИмени ):

  • Справочник - Catalog;
  • Документ - Document;
  • Журнал документов - DocumentJournal;
  • Константа - Constant;
  • План обмена - ExchangePlan;
  • План счетов - ChartOfAccounts
  • План видов расчета - ChartOfCalculationTypes;
  • План видов характеристик - ChartOfCharacteristicTypes;
  • Регистр сведений - InformationRegister;
  • Регистр накопления - AccumulationRegister;
  • Регистр расчета - CalculationRegister;
  • Регистр бухгалтерии - AccountingRegister;
  • Бизнес-процесс - BusinessProcess;
  • Задача - Task.

ИмяОбъектаКонфигурации - свойство «Имя» объекта конфигурации так, как оно задано в конфигураторе.

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

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

Параметры обращения к ресурсам

После формирования имени ресурса нужно определить параметры обращения к ресурсу, например, ?$filter=Значение &$format =json&$select= Ref_Key ,

  • $filter - отбор при получении данных
  • $format - указывает формат возвращаемых данных,
  • $select - перечисление свойств сущности, которые попадут в результат запроса;
  • $metadata - возвращает описание стандартного интерфейса OData (используется без указания суффикса имени, пример на одном из изображений выше);
  • $top - ограничение количества возвращаемых записей;
  • $skip - убирает из результата запроса указанное количество записей;
  • $count - возвращает количество записей в выборке запроса;
  • $inlinecount=allpage(=none) - добавляет в результат запроса информацию о количестве записей
  • $orderby=<Реквизит1> asc, <Реквизит2> desc - сортировка результата запроса
  • alloweOnly - только разрешенные (используется без знака «$»).

1.4 Получить массив записей регистра сведений

Посмотрим пример получения массив записей регистра сведения ФИОФизическихЛиц, например историю изменения ФИО физического лица

ИмяПубликации =" WebBuh"; Элемент = "InformationRegister_ФИОФизическихЛиц"; Период = Неопределено ; ДанныеСсылочногоТипа = Новый Структура (); ДанныеСсылочногоТипа .Вставить ("ФизическоеЛицо",ФизическоеЛицо_Key); ДанныеНЕСылочногоТипа = Новый Структура (); ДанныеНЕСылочногоТипа .Вставить ("ФизическоеЛицо_Type", "StandardODATA.Catalog_ФизическиеЛица") Массив = ПолучитьНаборЗаписиРегистраСведений (HTTPСоединение ,ИмяПубликации ,Элемент , Период ,ИзмеренияСсылочногоТипа , ИзмеренияНЕСылочногоТипа )

Тело функции ПолучитьНаборЗаписиРегистраСведений, которая вызывается в этом примере показано ниже

&НаСервере Функция ПолучитьНаборЗаписиРегистраСведений (HTTPСоединение ,ИмяПубликации ,Элемент , Период =Неопределено ,ИзмеренияСсылочногоТипа = Неопределено , ИзмеренияНЕСылочногоТипа = Неопределено ) ТекстЗапроса ="" ; Если Период <> Неопределено Тогда ФорматированныйПериод = Формат (Период ,"ДФ=yyyy-MM-ddTHH:mm:ss"); ТекстЗапроса = "Period = datetime""+ ФорматированныйПериод + """ ; КонецЕсли; Если ИзмеренияСсылочногоТипа <> Неопределено Тогда Для Каждого КлючЗначени е из ИзмеренияСсылочногоТипа Цикл Запитая = ? (ЗначениеЗаполнено (ТекстЗапроса ), "," ,""); ТекстЗапроса = ТекстЗапроса + Запитая + КлючЗначение.Ключ + "=guid(""+ КлючЗначение.Значение + "")"; КонецЦикла; КонецЕсли; Если ИзмеренияНЕСылочногоТипа <> Неопределено Тогда Для Каждого КлючЗначение из ИзмеренияНЕСылочногоТипа Цикл Запитая = ? (ЗначениеЗаполнено (ТекстЗапроса ), "," ,""); ТекстЗапроса = ТекстЗапроса + Запитая + КлючЗначение.Ключ + "=" + КлючЗначение.Значение ; КонецЦикла; КонецЕсли; АдресРесурса= ИмяПубликации + "/odata/standard.odata/" + Элемент + "("+ ТекстЗапроса + + ") ?$format=json "; //Вызов моей пользовательской функции СтруктураОтвета = ВызватьHTTPМетодНаСервере ("GET",HTTPСоединение ,АдресРесурса ); Если СтруктураОтвета .КодСостояния >= 400 Тогда //ОбщегоНазначенияКлиентСервер.СообщитьПользователю(Элемент+ " Ошибка "+СтруктураОтвета.КодСостояния); //ОбщегоНазначенияКлиентСервер.СообщитьПользователю(СтруктураОтвета.ОтветСервераНеРасшифрованный); Возврат неопределено; КонецЕсли; Соответствие = 0

Какие важнейшие требования предъявляются к бизнес-приложениям? Одними из самых главных являются следующие задачи:

  • Легкость изменения/адаптации логики работы приложения к меняющимся бизнес-задачам.
  • Легкость интеграции с другими приложениями.
То, как решается в 1С первая задача, было кратко описано в разделе «Кастомизация и поддержка» этой статьи ; мы еще вернемся к этой интересной теме в одной из будущих статей. Сегодня же речь пойдет о второй задаче, об интеграции.

Интеграционные задачи

Интеграционные задачи могут быть разными. Для решения одних достаточно простого интерактивного обмена данными – например, для передачи в банк списка сотрудников для оформления зарплатных пластиковых карт. Для более сложных задач может быть необходим полностью автоматизированный обмен данными, возможно, с обращением к бизнес-логике внешней системы. Есть задачи, носящие специализированный характер, вроде интеграции с внешним оборудованием (например, торговым оборудованием, мобильными сканерами и т.д.) или с унаследованными или узкоспециализированными системами (например, с системами распознавания RFID-меток). Крайне важно для каждой задачи выбрать наиболее подходящий механизм интеграции.

Возможности интеграции с 1С

Существуют различные подходы к реализации интеграции с приложениями 1С, какой из них выбрать – зависит от требований задачи.
Понравилось? Лайкни нас на Facebook