-М»
(ДОКУМЕНТАЛЬНЫЕ ИНФОРМАЦИОННЫЕ ТЕХНОЛОГИИ)
УТВЕРЖДАЮ | УТВЕРЖДАЮ |
Генеральный директор | Генеральный директор -М» |
______________ | _____________ |
«____»_____________2011 г. | «____»_______________2011 г. |
Руководство администратора
интеграционного модуля
Дата:
Версия:
Листов: 61
СОДЕРЖАНИЕ
1 Общие сведения….. ………………………………………………………………………….5
1.1 Руководящие документы.. 5
1.2 Описание электронного сервиса. 5
1.3 Операции (методы) электронного сервиса. 5
1.4 Сценарии использования. 7
1.5 Схема взаимодействия. 11
1.6 Связи с другими электронными сервисами. 12
2 Руководство пользователя……………………………………………………………... 12
2.1 Операция «Поиск библиографических записей». 12
2.1.1 Общие сведения. 12
2.1.2 Описание входных параметров. 13
2.1.3 Описание выходных параметров. 13
2.1.4 Коды возвратов. 13
2.1.5 Контрольные примеры.. 13
2.2 Операция «Поиск электронных документов». 19
2.2.1 Общие сведения. 19
2.2.2 Описание входных параметров. 20
2.2.3 Описание выходных параметров. 20
2.2.4 Коды возвратов. 20
2.2.5 Контрольные примеры.. 21
2.3 Операция «Предоставление доступа к электронному документу». 24
2.3.1 Общие сведения. 24
2.3.2 Описание входных параметров. 24
2.3.3 Описание выходных параметров. 25
2.3.4 Коды возвратов. 25
2.3.5 Контрольные примеры.. 26
3 Методика испытаний……………………………………………………………………... 28
3.1 Общие условия. 28
3.2 Параметры испытаний на тестовой среде. 28
3.3 Параметры испытаний на продуктивной среде. 28
4 Приложения……………………………………………………………………………………... 29
4.1 Описание сервиса (WSDL) 29
4.2 Описание общих структур данных. 48
4.2.1 tns:EServiceHeader (Специализированный заголовок запроса) 50
4.2.2 tns:EServiceResultBase (Cпециализированный заголовок возврата результата/статуса) 51
4.2.3 tns:EServiceResult (Cпециализированный заголовок возврата результата/статуса) наследует tns:EServiceResultBase и также включает в себя: 52
4.2.4 tns:EServiceResultContent (Cпециализированный заголовок возврата результата/статуса) наследует tns:EServiceResultBase и также включает в себя: 52
4.2.5 Параметр комплексного типа: tns:Find (Входные данные метода Find) 52
4.2.6 Параметр комплексного типа: tns:FindContent (Входные данные метода Find) 53
4.2.7 tns:SearchData (Условия поиска) 55
4.2.8 tns:SearchOperator (Содержимое логического оператора or или and) 55
4.2.9 tns:SearchElement (Условие поиска) 55
4.2.10 Параметр комплексного типа: tns:FindResponse (Выходные данные метода Find) 55
4.2.11 Параметр комплексного типа: tns:FindContentResponse (Выходные данные метода FindContent) 56
4.2.12 Параметр комплексного типа: tns:GetFileResponse (Выходные данные метода GetFile) 56
4.2.13 tns:ResultLibrary (Список всех библиотек с результатами поиска, только те, где есть хотя бы один результат поиска) 57
4.2.14 tns:ResultLibraryContent (Список всех библиотек с результатами поиска, только те, где есть хотя бы один результат поиска) 58
4.2.15 tns:LibraryBase (Список записей и атрибуты библиотеки) 58
4.2.16 tns:Library (Список записей и атрибуты библиотеки). 58
4.2.17 tns:LibraryContent (Список записей, имеющих электронные документы и атрибуты библиотеки). 59
4.2.18 tns:RecordList (Список всех записей, найденных в этой библиотеке) 59
4.2.19 tns:RecordContentList (Список всех записей, имеющих электронные документы) 59
4.2.20 tns:Record (Атрибуты записи) 59
4.2.21 Наследует tns:Record. 60
4.2.22 tns:File (Файл с информационным материалом). 60
4.3 Описания справочников. 60
4.4 Иные приложения. 61
термины/СОКРАЩЕНИя
Термин/сокращение | Описание |
СМЭВ | Система межведомственного электронного взаимодействия |
Поставщик | Организация-владелец электронного сервиса |
WSDL | Web Services Description Language — язык описания веб-сервисов. |
XSD | XML Schema definition - язык описания структуры XML документа. |
SOAP | Simple Object Access Protocol - протокол обмена структурированными сообщениями в распределённой вычислительной среде. |
XML | eXtensible Markup Language — расширяемый язык разметки. |
АБИС | Автоматизированная библиотечно-информационная система |
ЕПГУ | Единый портал государственных и муниципальных услуг |
1 Общие сведения
1.1 Руководящие документы
Основанием для разработки данного документа является требование п. 48 Приказа Министерства связи и массовых коммуникаций Российской Федерации от 27 декабря 2010 г. № 000 «Об утверждении технических требований к взаимодействию информационных систем в единой системе межведомственного электронного взаимодействия» в соответствии с которым, для подключения информационной системы к системе межведомственного электронного взаимодействия Поставщик предоставляет Оператору СМЭВ следующие документы:
- паспорт электронного сервиса, регистрируемого в системе взаимодействия;
- методику испытаний электронного сервиса, регистрируемого в системе взаимодействия, включая контрольный пример обращения к электронному сервису;
- руководство пользователя электронного сервиса, регистрируемого в системе взаимодействия.
Основанием для создания и использования электронного сервиса являются перечисленные ниже документы.
Нормативно-правовые документы:
- Постановление Правительства Российской Федерации от 8 сентября 2010 г. № 000 «О единой системе межведомственного электронного взаимодействия»;
- Приказ Министерства связи и массовых коммуникаций Российской Федерации от 01.01.01 г. № 000 «Об утверждении технических требований к взаимодействию информационных систем в единой системе межведомственного электронного взаимодействия».
1.2 Описание электронного сервиса
Наименование: | Веб-сервис предоставления доступа к справочно-поисковому аппарату библиотек и оцифрованным изданиям, хранящимся в библиотеках |
Назначение: | Предоставление доступа к справочно-поисковому аппарату библиотек и оцифрованным изданиям, хранящимся в библиотеках, в том числе к фонду редких книг, с учетом соблюдения требований законодательства Российской Федерации об авторских и смежных правах |
Поставщик: | -М» (Документальные информационные технологии) |
Область применения: | Предоставление населению доступа к библиотечной информации |
1.3 Операции (методы) электронного сервиса
Электронный сервис предоставления доступа к справочно-поисковому аппарату библиотек и оцифрованным изданиям, хранящимся в библиотеках, обеспечивает обмен данными.
Электронный сервис включает методы, обеспечивающие:
- предоставление доступа к справочно-поисковому аппарату библиотек, базам данных;
- предоставление доступа к оцифрованным изданиям, хранящимся в библиотеках, в том числе к фонду редких книг, с учетом соблюдения требований законодательства Российской Федерации об авторских и смежных правах.
Метод | Назначение |
Предоставление доступа к справочно-поисковому аппарату библиотек, базам данных Код: Find | 1) прием запроса на поиск от ЕПГУ в соответствии с требованиями к сервису Find (см. «Требование к Веб-сервису») 2) отправляет запрос на поиск в АБИС «OPAC-Global» и принимает от АБИС «OPAC-Global» ответ - список найденных библиографических записей со следующими атрибутами: Автор, Заглавие, ISBN, Место издания, Год издания, Издательство, Объем документа (в страницах или байтах), Местонахождение документа (наименование библиотеки-держателя) 3) возвращает список библиографических записей соответствующих условию в ЕПГУ в соответствии с требованиями к сервису Find (см. «Требование к Веб-сервису») |
Предоставление доступа к оцифрованным изданиям, хранящимся в библиотеках, в том числе к фонду редких книг, с учетом соблюдения требований законодательства Российской Федерации об авторских и смежных правах Код: FindContent Код: GetFile | 1) Прием запроса на поиск электронных документов в соответствии с требованиями к сервису FindContent 2) Отправка запроса на поиск электронных документов в АБИС «OPAC-Global» и прием от АБИС «OPAC-Global» ответа - списка найденных библиографических записей со следующими атрибутами: Автор, Заглавие, ISBN, Место издания, Год издания, Издательство, Объем документа (в страницах или байтах), Местонахождение документа (наименование библиотеки-держателя), идентификатор электронного докумета 3) Возврат списка библиографических записей соответствующих условию в соответствии с требованиями к сервису FindСontent 1) Прием запроса на предоставление электронного документа по идентификатору, полученному в методе FindContent в соответствии с требованиями к сервису GetFile 2) Отправка запроса на предоставление электронного документа в АБИС «OPAC-Global» и прием от АБИС «OPAC-Global» ответа 3) Возврат электронного документа в соответствии с требованиями к сервису GetFile |
1.4 Сценарии использования
Все методы АБИС по предоставлению доступа к справочному аппарату библиотек, базам данных и оцифрованным изданиям, хранящимся в библиотеках, в том числе к фонду редких книг, с учетом соблюдения требований законодательства РФ об авторских и смежных правах работают в синхронном режиме и включают в себя услуги: предоставление доступа к справочно-поисковому аппарату библиотек, базам данных и предоставление доступа к оцифрованным изданиям, хранящимся в библиотеках, в том числе к фонду редких книг, с учетом соблюдения требований законодательства РФ об авторских и смежных правах.
Предоставление услуг выполняется по следующим сценариям:
- Сценарий 1. Предоставление доступа к справочно-поисковому аппарату библиотек, базам данных (Блок-схема на рисунке 1) включает в себя:
o Обработка запроса от ЕПГУ
o Транслирование запроса ЕПГУ во внутренний запрос АБИС
o Получение записей, соответствующих данному поисковому запросу
o Реструктуризация запроса в соответствии с требованиями ЕПГУ
o Отправка ответа ЕПГУ
Рисунок 1.
- Сценарий 2. Предоставление доступа к оцифрованным изданиям, хранящимся в библиотеках, в том числе к фонду редких книг, с учетом соблюдения требований законодательства РФ об авторских и смежных правах реализуется в 2 этапа:
o Генерация списка записей, соответствующих поисковому запросу, для которых доступен полнотекстовый просмотр (см. выше блок-схему на рисунке 1).
- Обработка запроса от ЕПГУ Транслирование запроса ЕПГУ во внутренний запрос АБИС, добавление опции, отсекающей записи, для которых полнотекстовый просмотр недоступен Получение записей, соответствующих данному поисковому запросу Реструктуризация запроса в соответствии с требованиями ЕПГУ (в том числе добавление информации необходимой для получения полнотекстового просмотра) Отправка ответа ЕПГУ
o Предоставление полнотекстовой информации для конкретной записи (Блок-схема на рисунке 2).
- Обработка запроса от ЕПГУ, в котором содержится идентификатор требуемого файла Поиск данного файла в АБИС Определение типа содержимого файла Приведение содержимого файла к base64-строке Отправка ответа ЕПГУ
Рисунок 2.
1.5 Схема взаимодействия
В рамках взаимодействия возможно использование сервиса в двух видах услуг:
- предоставление доступа к справочно-поисковому аппарату библиотек, базам данных;
- предоставление доступа к оцифрованным изданиям, хранящимся в библиотеках, в том числе к фонду редких книг, с учетом соблюдения требований законодательства Российской Федерации об авторских и смежных правах.
При предоставлении доступа к справочно-поисковому аппарату библиотек, базам данных выполняются следующие действия:
- Веб-сервис, используя метод Find, получает от информационной системы ЕПГУ запрос на поиск;
- запрос на поиск отправляется в АБИС «OPAC-Global»;
- Веб-сервис получает от АБИС «OPAC-Global» ответ в форме списка найденных библиографических записей;
- Веб-сервис осуществляет возврат списка библиографических записей в адрес запрашивающей сведения ИС.
При предоставлении доступа к оцифрованным изданиям, хранящимся в библиотеках, в том числе к фонду редких книг, с учетом соблюдения требований законодательства Российской Федерации об авторских и смежных правах выполняются следующие действия: поиск записей, содержащих электронные документы, и поиск электронных документов.
При поиске записей, содержащих электронные документы:
- Веб-сервис, используя метод FindContent, получает от информационной системы ЕПГУ запрос на поиск записей с электронными документами;
- запрос на поиск записей с электронными документами отправляется в АБИС «OPAC-Global»;
- Веб-сервис получает от АБИС «OPAC-Global» ответ в форме списка найденных библиографических записей;
- Веб-сервис осуществляет возврат списка записей c id электронных документов в адрес запрашивающей сведения ИС.
При поиске электронных документов:
- Веб-сервис, используя метод GetFile, получает от информационной системы ЕПГУ запрос на поиск электронных документов;
- запрос на поиск электронных документов отправляется в АБИС «OPAC-Global»;
- Веб-сервис получает от АБИС «OPAC-Global» ответ в форме списка найденных библиографических записей;
- Веб-сервис осуществляет возврат списка электронных документов в адрес запрашивающей сведения ИС.
Схема взаимодействия представлена на рисунке 3.
Рисунок 3.
1.6 Связи с другими электронными сервисами
Данный сервис не имеет связей с другими сервисами.
2 Руководство пользователя
2.1 Операция «Поиск библиографических записей»
2.1.1 Общие сведения
Код операции: | Find |
Наименование операции: | Поиск библиографических записей |
Назначение операции: | Предоставление доступа к справочно-поисковому аппарату библиотек, базам данных |
2.1.2 Описание входных параметров
Входные данные: Find
| № | Код параметра | Описание параметра | Обязательность | Способ заполнения/ Тип | Комментарий |
|
1 | tns:RequestHeader | Унифицированный заголовок запроса | tns:RequestHeader | ||||
2 | tns:EServiceHeader | Специализированный заголовок запроса | tns:EServiceHeader | ||||
3 | tns:regData | Содержимое запроса | + | tns:regData | |||
2.1.3 Описание выходных параметров
Выходные данные: FindResponse
| № | Код параметра | Описание параметра | Обязательность | Способ заполнения/ Тип | Комментарий |
1 | tns:ResponseHeader | Унифицированный заголовок ответа | tns:ResponseHeader | |||
2 | tns:EServiceResult | Cпециализированный заголовок возврата результата | tns:EServiceResult | |||
Параметры комплексного типа описаны в приложении «Описание общих структур данных».
2.1.4 Коды возвратов
| № | Код возврата | Описание кода возврата | Условия возникновения | Комментарий |
|
1 | 3 | Сервис отработал успешно | Сервис отработал успешно. | |||
2 | -1 | Работа сервиса была прекращена из-за ошибки | Работа сервиса была прекращена из-за ошибки. | Подробности ошибки содержатся в узле RequestHeader. | ||
2.1.5 Контрольные примеры
Запрос
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas. xmlsoap. org/soap/envelope/" xmlns:ns1="http://www. *****/informLibrary/" SOAP-ENV:encodingStyle="http://schemas. xmlsoap. org/soap/encoding/"> <SOAP-ENV:Body> <ns1:Find> <RequestHeader> <authToken>libraryN</authToken> <requestDate>T16:38:46+04:00</requestDate> <requestId>12345</requestId> <requestInitiatorCode> <regionCode>77</regionCode> </requestInitiatorCode> </RequestHeader> <EServiceHeader> <userId>1234</userId> <eServiceId>12345</eServiceId> <stateOrgId>12345</stateOrgId> <orderDate>T16:38:46+04:00</orderDate> </EServiceHeader> <regData> <MaxResult>1000</MaxResult> <ExtSearchData> <Search> <Comparer>Start</Comparer> <Condition>Толстой</Condition> <AttributeRecord>Автор</AttributeRecord> </Search> </ExtSearchData> </regData> </ns1:Find> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
Ответ на запрос в случае успешного исполнения
|
Из за большого объема этот материал размещен на нескольких страницах:
1 2 3 4 5 6 |
