Министерство экономического развития Российской Федерации
ЗАО «Интерфакс»
УТВЕРЖДАЮ
|
|
УТВЕРЖДАЮ
|
Заместитель Министра экономического развития Российской Федерации
|
|
Первый заместитель генерального директора ЗАО «Интерфакс»
|
_____________________ О.В Фомичев
|
|
_______________________ В.В. Герасимов
|
«____»______________ г.
|
|
«____» ______________ г.
|
М.П.
|
|
М.П.
|
МОДЕРНИЗАЦИЯ ПРОГРАММНЫХ СРЕДСТВ ЕДИНОГО ФЕДЕРАЛЬНОГО ИНФОРМАЦИОННОГО РЕСУРСА СВЕДЕНИЙ О БАНКРОТСТВЕ (ШЕСТАЯ ОЧЕРЕДЬ)
Шифр темы 2125-09-11
ЕДИНЫЙ ФЕДЕРАЛЬНЫЙ ИНФОРМАЦИОННЫЙ РЕСУРС СВЕДЕНИЙ О БАНКРОТСТВЕ
Руководство программиста
В ЧАСТИ УПРАВЛЕНИЯ ДОСТУПА К ВЕБ-СЕРВИСАМ ПОЛУЧЕНИЯ СООБЩЕНИЙ О БАНКРОТСТВЕ
СОГЛАСОВАНО
|
|
Заместитель директора Департамента корпоративного управления Минэкономразвития России
|
|
____________________ Д. В. Скрипичников
«___»___________________2011 г.
|
|
АННОТАЦИЯ
В данном программном документе приведено руководство программиста по настройке, использованию и доработке программы АИС «Сведения о банкротстве» в части управления доступа к веб-сервисам получения сообщений о банкротстве.
В данном программном документе, в разделе «Назначение и условия применения программы» указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.).
В разделе «Характеристика программы» приведено описание основных характеристик и особенностей программы (режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).
В данном программном документе, в разделе «Входные и выходные данные» приведено описание организации используемой входной и выходной информации.
В разделе «Сообщения» указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
Оформление программного документа «Руководство программиста» произведено по требованиям ЕСПД (ГОСТ 19.101-77 1), ГОСТ 19.103-77 2), ГОСТ 19.104-78* 3), ГОСТ 19.105-78* 4), ГОСТ 19.106-78* 5), ГОСТ 19.504-79* 6), ГОСТ 19.604-78* 7)).
Содержание
1)Назначение и условия применения программы 4
1.1Назначение программы 4
1.2Функции, выполняемые программой 4
1.3Условия, необходимые для выполнения программы 4
1.3.1Объем оперативной памяти 4
1.3.2Требования к составу периферийных устройств 4
1.3.3Требования к параметрам периферийных устройств 4
1.3.4Требования к программному обеспечению 4
1.3.5Требования к персоналу (программисту) 5
2)Характеристика программы 6
2.1Описание основных характеристик программы 6
2.1.1Режим работы программы 6
2.1.2Средства контроля правильности выполнения программы 6
2.2Описание основных особенностей программы 6
2.2.1Самовосстанавливаемость программы 6
3)Обращение к программе 7
3.1Загрузка и запуск программы 7
3.2Выполнение программы 7
3.2.1Выполнение процедуры аутентификации 7
3.2.2Выполнение процедуры предоставления списка идентификаторов сообщений за дату 7
4)В БД системы производится поиск сообщений, опубликованных за переданную дату. 7
5)Если сообщения найдены, то формируется список идентификаторов сообщений, дата публикации которых равна переданной. 7
6)Если сообщения не найдены, то формируется ответ, содержащий пустой список идентификаторов. 7
7)Если при выполнении Веб-сервисов возникла ошибка, то информация о ней отправляется инициатору взаимодействия и заносится в журнал событий Веб-сервисов. 7
7.1.1Выполнение процедуры предоставления сообщения по идентификатору 7
1)В БД системы производится поиск сообщения с указанным идентификатором. 7
8)Если сообщение найдено, то оно передается в неизменном виде. 7
9)Если сообщения с запрашиваемым идентификатором не найдено, то формируется ответ, содержащий соответствующее сообщение. 7
10)Если в процессе выполнения операции возникла ошибка, то информация о ней отправляется инициатору взаимодействия и заноситя в журнал событий Веб-сервисов. 7
10.1.1Выполнение процедуры логирования 7
10.2Завершение работы программы 8
11)Входные и выходные данные 9
11.1Организация используемой входной информации 9
11.2Организация используемой выходной информации 9
12)Сообщения 13
12.1Сообщение об ошибке 13
12.2Сообщение о неуспешной авторизации 13
12.3Сообщение о успешной авторизации 14
12.4Сообщение при запросе сообщений за дату 14
12.5Сообщение при запросе содержимого сообщения по идентификатору 14
13)Состав архивов инсталляционного пакета 15
1)Назначение и условия применения программы
1.1Назначение программы
Программные средства (веб-сервисы) для предоставления зарегистрированным пользователям АИС «Сведения о банкротстве» возможности автоматизированного получения опубликованных сообщений в ЕФРСБ (далеее – веб-сервисы или программа) предназначены для предоставления зарегистрированным пользователям АИС «Сведения о банкротстве» возможности автоматизированного получения опубликованных сообщений.
1.2Функции, выполняемые программой
Основные функции веб-сервисов:
Аутентификация пользователей;
Предоставление списка идентификаторов сообщений за дату;
Предоставление сообщения по идентификатору;
Логирование.
1.3Условия, необходимые для выполнения программы
1.3.1Объем оперативной памяти
Для выполнения своих функций, программе достаточно:
50 Мб оперативной памяти на рабочей станции пользователя;
300 Мб оперативной памяти на сервере приложений;
1 Гб оперативной памяти на сервере на сервере БД.
Однако, поскольку часть ОЗУ неизбежно занимает операционная система, то рекомендуется использовать программу на оборудовании, имеющем следующие параметры:
более 512 Мб оперативной памяти на рабочей станции пользователя;
более 2 Гб оперативной памяти на сервере приложений;
более 4 Гб оперативной памяти на сервере на сервере БД.
1.3.2Требования к составу периферийных устройств
Для работы необходимо наличие следующих периферийных устройств:
выделенного диска объемом не менее 300 Гб на сервере БД;
наличие подключения к локальной вычислительной сети у сервера приложений и сервера БД;
наличие подключения к сети Интернет на рабочей станции пользователя.
1.3.3Требования к параметрам периферийных устройств
Периферийные устройства, требуемые для работы программы, должны иметь следующие параметры:
выделенный диски должен иметь надежность хранения не ниже, чем у RAID-5 массива;
локальная вычислительная сеть должна иметь пропускную способность способностью не ниже 100Мб/сек;
подключение к сети Интернет на рабочей станции должно обеспечивать пропускную способность не менее 56 Кб/сек.
1.3.4Требования к программному обеспечению
Для работы программы требуются следующее программное обеспечение:
на рабочей станции пользователя
браузер Internet Explorer версии 6 или выше или браузер Mozilla Firefox версии 3 или выше;
операционная система Windows XP SP2 или более поздняя версия;
для подписи сообщений ЭЦП необходим комплект программного обеспечения VipNet компании Инфотекс;
на сервере приложений:
операционная система Windows 2003 32-bit;
Internet Information Services версии 6;
в операционной системе должна быть установлена исполняемая среда .NET версии 2.0.
на сервере БД:
операционная система Windows 2003 Standard Edition;
Microsoft SQL Server 2005 Standard Edition.
Для доработки программы требуется следующее программное обеспечение:
среда разработки Visual Studio 2008;
библиотека и исполняемая среда .NET версии 2.0.
1.3.5Требования к персоналу (программисту)
Программист должен иметь минимум среднее техническое образование, обладать знаниями языков программирования C# и Transact-SQL.
В перечень задач, выполняемых программистом, должны входить:
задача поддержания работоспособности программы;
доработка программы по требованиям пользователей системы.
2)Характеристика программы
2.1Описание основных характеристик программы
2.1.1Режим работы программы
Режим работы программы - круглосуточный, непрерывный.
2.1.2Средства контроля правильности выполнения программы
Контроль правильности выполнения программы осуществляется через файлы логов программы. В случае возникновения исключительных ситуаций, которые не могут быть обработаны средствами системы, информация о них выводится в файлы логов (расположение файлов логов задается в конфигурационных файлах программы).
2.2Описание основных особенностей программы
Настройка программы осуществляется с помощью конфигурационных файлов. Описание конфигурационных файлов и их параметров приведено в инструкции по инсталляции системы.
2.2.1Самовосстанавливаемость программы
Серверные компоненты программы имеют возможность работы в режиме, когда не требуется их ручное восстановление после сбоев или после перезагрузки компьютера. Такой режим устанавливается настройками операционной системы (автостарт сервисов после перезагрузки и/или сбоев) и Internet Information Services.
3)Обращение к программе
3.1Загрузка и запуск программы
Запуск программы зависит от типа компонент:
компоненты, исполняемые в среде Internet Information Services (сайты) загружаются и запускаются автоматически при обращении к сайтам пользователей;
компоненты, исполняемые в виде windows-сервисов, в первый раз должны быть запущены из консоли управления сервисами. Подробное описание порядка работы с консолью управления сервисами приведено в руководстве пользователя операционной системы.
3.2Выполнение программы
3.2.1Выполнение процедуры аутентификации
Для получения сведений через Веб-сервисы пользователями Веб-сервисов должна быть пройдена процедура аутентификации на основе учетных данных, предоставленных оператором ЕФРСБ.
В случае отказа в аутентификации (например, из-за неверно указанного пароля) выводится соответствующее информационное сообщение.
В качестве метода аутентификации используется Digest аутентификация. Аутентификационные данные передаются в заголовке Authorization HTTP-запроса.
3.2.2Выполнение процедуры предоставления списка идентификаторов сообщений за дату
Веб-сервисы обеспечивают предоставление списка идентификаторов опубликованных за запрашиваемую дату сообщений.
Алгоритм процедуры следующий:
4)В БД системы производится поиск сообщений, опубликованных за переданную дату.
5)Если сообщения найдены, то формируется список идентификаторов сообщений, дата публикации которых равна переданной.
6)Если сообщения не найдены, то формируется ответ, содержащий пустой список идентификаторов.
7)Если при выполнении Веб-сервисов возникла ошибка, то информация о ней отправляется инициатору взаимодействия и заносится в журнал событий Веб-сервисов.
7.1.1Выполнение процедуры предоставления сообщения по идентификатору
Веб-сервисы обеспечивают предоставление авторизованным пользователям сообщения по идентификатору в ЕФРСБ. Сообщение предоставляется в том виде, в котором оно было подписано опубликовавшим его пользователем
Алгоритм процедуры следующий:
-
В БД системы производится поиск сообщения с указанным идентификатором.
8)Если сообщение найдено, то оно передается в неизменном виде.
9)Если сообщения с запрашиваемым идентификатором не найдено, то формируется ответ, содержащий соответствующее сообщение.
10)Если в процессе выполнения операции возникла ошибка, то информация о ней отправляется инициатору взаимодействия и заноситя в журнал событий Веб-сервисов.
10.1.1Выполнение процедуры логирования
Веб-сервис логирует факты аутентификации пользователей и факты обращения за сведениями. В журнале (логе) Веб-сервисов регистрируется следующая информация:
факты аутентификации пользователей;
факты обращения за сведениями;
возникшие в ходе работы Веб-сервисов ошибки.
В каждом событии журнала фиксируются следующие параметры:
дата и время обращения;
логин пользователя;
IP-адрес, с которого был осуществлен запрос;
параметры запроса (в частности, типы и идентификаторы запрашиваемых сообщений или периоды запроса информации).
10.2Завершение работы программы
Завершение работы программы осуществляется:
остановкой windows-сервисов в консоли управления сервисами операционной системы сервера приложений;
остановкой сайта в консоли управления Internet Information Services;
остановкой сервера БД в консоли управления SQL Server 2005 (SQL Management Studio);
закрытием окна браузера на рабочем месте пользователя.
11)Входные и выходные данные
11.1Организация используемой входной информации
Программа получает входную информацию в формате XML.
Пример входных данных для запроса идентификаторов сообщений за дату 01.01.2009 приведён ниже.
2009-01-01T00:00:00
Пример входных данных для запроса текста сообщения с идентификатором 492 приведён ниже.
492
11.2Организация используемой выходной информации
Программа генерирует ответы на запросы в формате XML.
Пример ответа на запрос идентификаторов сообщений за дату 01.01.2009 приведён ниже.
492
493
494
495
496
497
В случае отсутствия сообщений за указанную дату будет получен ответ:
Пример ответа на запрос содержимого сообщения по идентификатору 492 приведён ниже.
<MessageData xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:xsd="http://www.w3.org/2001/XMLSchema"><Id>487</Id><Number>000487</Number><FileNumber>888</FileNumber><PublisherInfo PublisherType="ArbitrManager"><ArbitrManager Id="72808" FirstName="И" MiddleName="О" LastName="Дубаденко" INN="111222333444" RegistryNumber="123-3111"><Sro SroId="93"><SroName>НП "МСОАУ "Стратегия" - Некоммерческое партнерство "Межрегиональная саморегулируемая организация арбитражных управляющих "Стратегия"</SroName><SroRegistryNumber>0015</SroRegistryNumber></Sro></ArbitrManager></PublisherInfo><MessageInfo MessageType="ArbitralDecree"><CourtDecision><Text>1111</Text><FirstCourt><CourtId>1</CourtId><CourtName>Высший Арбитражный Суд РФ</CourtName><FileNumber>121</FileNumber><DecisionDate>2009-09-07</DecisionDate></FirstCourt></CourtDecision></MessageInfo><BankruptInfo BankruptType="Organization"><BankruptFirm Id="133" UrAddress="1" FullName="1" ShortName="1" PostAddress="1"><CommonName>1</CommonName></BankruptFirm></BankruptInfo></MessageData>
В случае отсутствия сообщения по идентификатору генерируется ответ:
s:Client
Сообщение не найдено по идентификатору 4920
При некорректном задании входных данных выдаётся сообщение:
s:Client
Некорректно задан идентификатор сообщения.
При ошибках приложения пользователь получит сообщение:
s:Client
В процессе работы приложения произошла ошибка.
12)Сообщения
12.1Сообщение об ошибке
При возникновении ошибки (необработанного исключения) в программе, например, в случае ошибки в процессе авторизации, в логах системы будет следующее сообщение:
2011-12-05 14:27:43.0620 : Error : В процессе авторизации клиента ip: 127.0.0.1 произошла ошибка.
Method is
Interfax.Bankruptcy.MessageService.Security.Authentication.DigestModule.OnAuthenticateRequest(DigestModule.cs:113)
Exception is
System.FormatException: Входная строка имела неверный формат.
в System.Number.StringToNumber(String str, NumberStyles options, NumberBuffer& number, NumberFormatInfo info, Boolean parseDecimal)
в System.Number.ParseUInt32(String value, NumberStyles options, NumberFormatInfo numfmt)
в System.Convert.ToUInt32(String value)
в Interfax.Bankruptcy.MessageService.Security.Authentication.DigestAuthenticationService.CheckUserAndPassword(String header, String httpMethod, String password) в C:\Projects\Bankruptcy\SourcesIteration6\Services\MessageService\Interfax.Bankruptcy.MessageService.Security\Authentication\DigestAuthenticationService.cs:строка 124
в Interfax.Bankruptcy.MessageService.Security.Authentication.DigestModule.OnAuthenticateRequest(Object sender, EventArgs e) в C:\Projects\Bankruptcy\SourcesIteration6\Services\MessageService\Interfax.Bankruptcy.MessageService.Security\Authentication\DigestModule.cs:строка 91
В тексте сообщения об ошибке присутствует строка «2011-12-05 14:27:43.0620 : Error : В процессе авторизации клиента ip: 127.0.0.1 произошла ошибка», в которой указано время занесения ошибки в лог и описание ошибки. Далее приводится информация о стеке вызова.
12.2Сообщение о неуспешной авторизации
При неуспешной авторизации пользователя в логе сервиса появится следующее сообщение:
2011-12-06 12:16:35.2278 : Клиент ip: 127.0.0.1 не прошёл авторизацию.
12.3Сообщение о успешной авторизации
При успешной авторизации пользователя в логе сервиса появится следующее сообщение:
2011-12-05 14:39:43.0984 : Клиент ip: 127.0.0.1, name: testUser успешно прошёл авторизацию.
12.4Сообщение при запросе сообщений за дату
При запросе сообщений за дату 01.01.2009 в лог записывается сообщение:
2011-12-06 12:48:28.7792 : Пользователь: testUser, ip: 127.0.0.1 запросил сообщения за дату 01.01.2009
12.5Сообщение при запросе содержимого сообщения по идентификатору
При запросе содержимого сообщения по идентификатору 492 в лог записывается сообщение
2011-12-06 12:48:30.4073 : Пользователь: testUser, ip: 127.0.0.1 запросил сообщение по идентификатору 492
13)Состав архивов инсталляционного пакета
Инсталляционный пакет находится в файле MessageService.rar. В таблице 1 приведён состав архива MessageService.rar.
Таблица 1 — Состав архива MessageService.rar
Файл
|
Описание
|
Interfax.Bankruptcy.MessageService.Setup.msi
|
Инсталляционный файл с используемыми модулями приложения
|
setup.exe
|
Приложение, управляющее процессом инсталляции
|
"РУКОВОДСТВО ПРОГРАММИСТА" СОСТАВИЛИ:
Наименование организации, предприятия
|
Должность исполнителя
|
Фамилия, имя, отчество
|
Подпись
|
Дата
|
ЗАО «Интерфакс»
|
Менеджер проектов
|
Малышев Сергей Геннадьевич
|
|
|
ЗАО «Интерфакс»
|
Аналитик
|
Зубарева Марина Тагировна
|
|
|
ЗАО «Интерфакс»
|
Технический писатель
|
Смирнова Юлия Ивановна
|
|
|
СОГЛАСОВАНО
Наименование организации, предприятия
|
Должность исполнителя
|
Фамилия, имя, отчество
|
Подпись
|
Дата
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Москва, 2011
|
